Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.
Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.
The last entry the writer read (its seq). The write is refused as stale when what it reads changed after it; a write elsewhere in the log is not. Omit to write against the head.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Effective","description":"Research insurance markets with the Effective API and analyze premiums locally with Relativities.","colors":{"primary":"#171717","light":"#EAEBE6","dark":"#171717"},"logo":{"light":"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/logo/light.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=1dea6fc4d5e457e6149af14837c5112e","dark":"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/logo/dark.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=f739f525573ed266bd41eb0cfa03762e"},"favicon":"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/favicon.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=21d4037b0c44f2a18631aa8da87a6adf","api":{"playground":{"display":"interactive"}},"background":{"color":{"light":"#FDFDFC","dark":"#1F201D"}},"navbar":{"links":[{"href":"https://effectiveailabs.com/support","label":"Support"}]},"seo":{"metatags":{"canonical":"https://docs.canary.effectiveai.app","robots":"noindex"},"indexing":"navigable"},"styling":{"codeblocks":{"languages":{"custom":["languages/rsl.tmLanguage.json"]}},"latex":true},"integrations":{"posthog":{"apiKey":"phc_lqBgNxwfmrWDRHilA0uhs7vjD1fjHwUC3zALvFLGb3e","apiHost":"https://us.i.posthog.com","sessionRecording":false}},"banner":{"content":"Canary documentation. Features may not be released to production. [Production docs](https://docs.effectiveai.app).","dismissible":false},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"effective-ai-canary","hasAudioNarration":false,"actualSubdomain":"effective-ai-canary","customDomains":["docs.canary.effectiveai.app"],"gitSource":{"type":"github","owner":"effectiveailabs","repo":"effectiveai","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af645b2a934c1149e0d6667","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"API Reference","count":252},{"language":"default","tag":"RSL","count":51},{"language":"default","tag":"Relativities","count":37},{"language":"default","tag":"Reference","count":23},{"language":"default","tag":"OSHA","count":23},{"language":"default","tag":"Your programs","count":23},{"language":"default","tag":"Managed Filings","count":22},{"language":"default","tag":"Objections","count":21},{"language":"default","tag":"Market Directory","count":16},{"language":"default","tag":"Products","count":16}]},"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":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[{"filePath":"guide-index.css","content":".research-guide-index h3{font-size:1rem!important;font-weight:500!important;line-height:1.5!important;margin-top:1.25rem!important;margin-bottom:0.5rem!important}.research-guide-index h3 a{font-weight:500!important;text-decoration:none!important;border-bottom:0!important}.research-guide-index h3 a[href^=\"/guides/\"]::after{content:' →';display:inline-block;margin-left:0.25rem}.research-guide-index h3 a:hover,.research-guide-index h3 a:focus-visible{text-decoration:underline!important;text-underline-offset:0.2em}.research-guide-index h3+p{margin-top:0.5rem!important}.research-guide-index hr{margin-top:1.5rem!important;margin-bottom:1.5rem!important}"}],"page":{"pagePath":"api-reference/your-programs/preview-a-write-to-a-log","slug":"/api-reference/your-programs/preview-a-write-to-a-log","pageMetadata":{"title":"Preview a write to a log","description":"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/logs/{log}/what-if","href":"/api-reference/your-programs/preview-a-write-to-a-log","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: \"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.\"\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":{"codeStyling":{"languages":{"custom":["languages/rsl.tmLanguage.json"]}},"config":{},"pageMetadata":{"title":"Preview a write to a log","description":"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/logs/{log}/what-if","href":"/api-reference/your-programs/preview-a-write-to-a-log","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"previewProgramLogCommands","x-effective-mcp":{"readOnly":true,"kind":"item"},"tags":["Your programs"],"security":["8930f695-d786-4d9b-9704-ebf48344a56e"],"summary":"Preview a write to a log","description":"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.","parameters":["553ef59f-f028-418e-b180-92d524d93c23","7933c868-db6a-42f7-869f-2c6dc66c5866"],"requestBody":"fe19e5e7-aecc-4383-95a5-ff6bbf873415","responses":{"200":"7f5af9b2-03cc-4adc-9184-5dda16f8d608","400":"efba8a56-8d69-4606-9627-b49687481489","401":"7e762f54-b92d-4f20-a913-3e33dd4f356d","403":"94566b23-740e-4174-a3d6-960b6ace94b2","404":"88a081f4-868e-4a24-a9cc-913c6e989b2b","409":"335fdf1d-c208-4d2b-9c39-b60efcd6bdec","422":"ff2716fb-4422-4768-8c70-9dcb483229e7"},"method":"post","type":"path","servers":["d4461ff1-bf63-4ec4-86ec-270ae603f08d"],"path":"/rsl/{id}/logs/{log}/what-if","baseUrlOptions":["https://api.canary.effectiveai.app/api/v2"],"title":"Preview a write to a log","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"553ef59f-f028-418e-b180-92d524d93c23":{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z0-9][a-z0-9._-]{0,127}$","description":"Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"Your organization’s ID for the program, chosen at its first upload: lowercase letters, digits, dots, underscores and hyphens. A rater’s program ID is its rater ID.","name":"id","in":"path"},"7933c868-db6a-42f7-869f-2c6dc66c5866":{"schema":{"type":"string","format":"uuid","description":"The log’s id: a UUID the caller chooses when it opens the log, such as the id of the case the log decides. One id has one log.","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"The log’s id: a UUID the caller chooses when it opens the log, such as the id of the case the log decides. One id has one log.","name":"log","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"commands":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","question","value"],"properties":{"kind":{"type":"string","enum":["answer"],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"question":{"type":"string","minLength":1,"maxLength":500,"description":"An input’s path under the root record (policy.payroll), or a referral’s name for a sign-off.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.question","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"number","description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.2","typeLabel":"boolean"},{"description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.3","typeLabel":"any"},{"type":"null","description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.4","typeLabel":"null"},{"type":"array","items":{"oneOf":[{},{"type":"null","uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.5.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.5.items.[INDEX]","typeLabel":"null"},"description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.5","typeLabel":"null[]"},{"type":"object","description":"The answer, as the contract’s questions schema reads it. For a sign-off, Approved or Declined.","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.6.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.6.additionalProperties","typeLabel":"null"},"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value.oneOf.6","typeLabel":"object"}],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.0.value","typeLabel":"string | number | boolean | any | null | null[] | object"},"from":{"type":"string","minLength":1,"maxLength":2000,"description":"Where the answer comes from, such as a document page.","uniqueKey":"commands.items.[INDEX].oneOf.0.from","typeLabel":"string"},"because":{"type":"string","minLength":1,"maxLength":2000,"description":"Why the actor gives it. A sign-off, and an answer to a question a role holds, need one (REASON_REQUIRED).","uniqueKey":"commands.items.[INDEX].oneOf.0.because","typeLabel":"string"},"option":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$/u","description":"A quote option: the command writes in that option’s view. Omit for the shared answers.","uniqueKey":"commands.items.[INDEX].oneOf.0.option","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"commands.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","question"],"properties":{"kind":{"type":"string","enum":["retract"],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"question":{"type":"string","minLength":1,"maxLength":500,"description":"An input’s path under the root record (policy.payroll), or a referral’s name for a sign-off.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.1.question","typeLabel":"string"},"option":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$/u","description":"A quote option: the command writes in that option’s view. Omit for the shared answers.","uniqueKey":"commands.items.[INDEX].oneOf.1.option","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"commands.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","name"],"properties":{"kind":{"type":"string","enum":["quote"],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"name":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$/u","description":"A quote’s or quote option’s name, such as q1 or with_pl.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.2.name","typeLabel":"string"},"option":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$/u","description":"A quote option: the command writes in that option’s view. Omit for the shared answers.","uniqueKey":"commands.items.[INDEX].oneOf.2.option","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"commands.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","name"],"properties":{"kind":{"type":"string","enum":["bind"],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"name":{"type":"string","pattern":"^[A-Za-z_][A-Za-z0-9_]{0,63}$/u","description":"A quote’s or quote option’s name, such as q1 or with_pl.","isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.3.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"commands.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","reason"],"properties":{"kind":{"type":"string","enum":["close"],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["withdrawn","expired","lost","declined"],"isRequired":true,"uniqueKey":"commands.items.[INDEX].oneOf.4.reason","typeLabel":"enum\u003cstring>"},"because":{"type":"string","minLength":1,"maxLength":2000,"uniqueKey":"commands.items.[INDEX].oneOf.4.because","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"commands.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"commands.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":500,"isRequired":true,"uniqueKey":"commands","typeLabel":"object[]"},"basedOn":{"type":"integer","minimum":0,"description":"The last entry the writer read (its seq). The write is refused as stale when what it reads changed after it; a write elsewhere in the log is not. Omit to write against the head.","uniqueKey":"basedOn","typeLabel":"integer"},"role":{"type":"string","pattern":"^[a-z_][a-z0-9_]{0,63}$/u","description":"The role to act in, for a caller who holds several on this guideline. Defaults to the only one held.","uniqueKey":"role","typeLabel":"string"}},"required":["commands"],"additionalProperties":false,"description":"One write: its commands, recorded together or not at all.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"commands":[{"kind":"answer","question":"\u003cstring>","value":"\u003cstring>","from":"\u003cstring>","because":"\u003cstring>","option":"\u003cstring>"}],"basedOn":1,"role":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7f5af9b2-03cc-4adc-9184-5dda16f8d608":{"description":"What the write would record and the verdict after it.","content":{"application/json":{"schema":{"type":"object","properties":{"head":{"type":"integer","description":"The log’s last entry, which a what-if does not move.","isRequired":true,"uniqueKey":"head","typeLabel":"integer"},"entries":{"type":"array","items":{"type":"object","properties":{"seq":{"type":"integer","description":"The entry’s position, from 1.","isRequired":true,"uniqueKey":"entries.items.[INDEX].seq","typeLabel":"integer"},"at":{"type":"string","description":"When the host wrote it. No rule reads it.","isRequired":true,"uniqueKey":"entries.items.[INDEX].at","typeLabel":"string"},"by":{"type":"object","properties":{"role":{"type":"string","description":"The program role written in.","isRequired":true,"uniqueKey":"entries.items.[INDEX].by.role","typeLabel":"string"},"id":{"type":"string","description":"Who wrote: the user.","isRequired":true,"uniqueKey":"entries.items.[INDEX].by.id","typeLabel":"string"}},"required":["role","id"],"isRequired":true,"uniqueKey":"entries.items.[INDEX].by","typeLabel":"object"},"event":{"type":"object","properties":{"type":{"type":"string","enum":["opened","answered","signed_off","retracted","quoted","bound","closed"],"description":"What happened.","isRequired":true,"uniqueKey":"entries.items.[INDEX].event.type","typeLabel":"enum\u003cstring>"}},"required":["type"],"additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"entries.items.[INDEX].event.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].event.additionalProperties","typeLabel":"null"},"description":"The event and its fields, as rsl-log writes them.","isRequired":true,"uniqueKey":"entries.items.[INDEX].event","typeLabel":"object"}},"required":["seq","at","by","event"],"uniqueKey":"entries.items.[INDEX]","typeLabel":"object"},"description":"The entries the write would record.","isRequired":true,"uniqueKey":"entries","typeLabel":"object[]"},"verdict":{"type":"object","description":"The verdict after them.","required":["stage","outcomes","declines","open","referrals","invalid","quotes"],"properties":{"stage":{"type":"string","enum":["Open","Ineligible","Declined","Quotable","Bound","Closed"],"description":"Where the submission stands.","isRequired":true,"uniqueKey":"verdict.stage","typeLabel":"enum\u003cstring>"},"outcomes":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"verdict.outcomes.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.outcomes.additionalProperties","typeLabel":"null"},"description":"The rating outcomes; empty while any is unknown.","isRequired":true,"uniqueKey":"verdict.outcomes","typeLabel":"object"},"declines":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The rule’s code, or the referral’s name.","isRequired":true,"uniqueKey":"verdict.declines.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"verdict.declines.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"verdict.declines.items.[INDEX].path","typeLabel":"string"},"cite":{"oneOf":[{"description":"A JSON value, as the program reads it. Numbers as written.","uniqueKey":"verdict.declines.items.[INDEX].cite.oneOf.0","typeLabel":"any"},{"description":"A JSON value, as the program reads it. Numbers as written.","type":"null","uniqueKey":"verdict.declines.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.declines.items.[INDEX].cite","typeLabel":"any | null"}},"required":["code","message","path"],"uniqueKey":"verdict.declines.items.[INDEX]","typeLabel":"object"},"description":"Rules and sign-offs that decline.","isRequired":true,"uniqueKey":"verdict.declines","typeLabel":"object[]"},"open":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","description":"An input’s path, or a referral’s name.","isRequired":true,"uniqueKey":"verdict.open.items.[INDEX].question","typeLabel":"string"},"kind":{"type":"string","enum":["input","signoff"],"isRequired":true,"uniqueKey":"verdict.open.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"role":{"oneOf":[{"type":"string","description":"The lowest role that may answer it.","isRequired":true,"uniqueKey":"verdict.open.items.[INDEX].role.oneOf.0","typeLabel":"string"},{"type":"null","description":"The lowest role that may answer it.","isRequired":true,"uniqueKey":"verdict.open.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"verdict.open.items.[INDEX].role","typeLabel":"string | null"},"choices":{"oneOf":[{"description":"A JSON value, as the program reads it. Numbers as written.","uniqueKey":"verdict.open.items.[INDEX].choices.oneOf.0","typeLabel":"any"},{"description":"A JSON value, as the program reads it. Numbers as written.","type":"null","uniqueKey":"verdict.open.items.[INDEX].choices.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.open.items.[INDEX].choices","typeLabel":"any | null"},"because":{"type":"string","uniqueKey":"verdict.open.items.[INDEX].because","typeLabel":"string"},"reads":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"verdict.open.items.[INDEX].reads.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"A JSON value, as the program reads it. Numbers as written.","uniqueKey":"verdict.open.items.[INDEX].reads.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"A JSON value, as the program reads it. Numbers as written.","type":"null","uniqueKey":"verdict.open.items.[INDEX].reads.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.open.items.[INDEX].reads.items.[INDEX].value","typeLabel":"any | null"}},"required":["path"],"uniqueKey":"verdict.open.items.[INDEX].reads.items.[INDEX]","typeLabel":"object"},"uniqueKey":"verdict.open.items.[INDEX].reads","typeLabel":"object[]"}},"required":["question","kind","role"],"uniqueKey":"verdict.open.items.[INDEX]","typeLabel":"object"},"description":"The questions still open.","isRequired":true,"uniqueKey":"verdict.open","typeLabel":"object[]"},"referrals":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The referral’s name. A referral on the items of a keyed list is one per item, named by the item’s address.","isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].name","typeLabel":"string"},"state":{"type":"string","enum":["Unknown","NotReferred","Open","Approved","Declined"],"isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"role":{"type":"string","description":"The lowest role that may sign it off.","isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].role","typeLabel":"string"},"because":{"type":"string","isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].because","typeLabel":"string"},"lapsed":{"type":"boolean","description":"A sign-off was given and no longer counts: a value it reads changed.","isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].lapsed","typeLabel":"boolean"},"reads":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].reads.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"A JSON value, as the program reads it. Numbers as written.","uniqueKey":"verdict.referrals.items.[INDEX].reads.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"A JSON value, as the program reads it. Numbers as written.","type":"null","uniqueKey":"verdict.referrals.items.[INDEX].reads.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.referrals.items.[INDEX].reads.items.[INDEX].value","typeLabel":"any | null"}},"required":["path"],"uniqueKey":"verdict.referrals.items.[INDEX].reads.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"verdict.referrals.items.[INDEX].reads","typeLabel":"object[]"}},"required":["name","state","role","because","lapsed","reads"],"uniqueKey":"verdict.referrals.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"verdict.referrals","typeLabel":"object[]"},"invalid":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The rule’s code, or the referral’s name.","isRequired":true,"uniqueKey":"verdict.invalid.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"verdict.invalid.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"verdict.invalid.items.[INDEX].path","typeLabel":"string"},"cite":{"oneOf":[{"description":"A JSON value, as the program reads it. Numbers as written.","uniqueKey":"verdict.invalid.items.[INDEX].cite.oneOf.0","typeLabel":"any"},{"description":"A JSON value, as the program reads it. Numbers as written.","type":"null","uniqueKey":"verdict.invalid.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.invalid.items.[INDEX].cite","typeLabel":"any | null"}},"required":["code","message","path"],"uniqueKey":"verdict.invalid.items.[INDEX]","typeLabel":"object"},"description":"Answers the contract refuses.","isRequired":true,"uniqueKey":"verdict.invalid","typeLabel":"object[]"},"quotes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"verdict.quotes.items.[INDEX].name","typeLabel":"string"},"outcomes":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"verdict.quotes.items.[INDEX].outcomes.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"verdict.quotes.items.[INDEX].outcomes.additionalProperties","typeLabel":"null"},"description":"Each rating outcome by name, numbers as the program computed them. An outcome on the items of a keyed list is an object by item key.","isRequired":true,"uniqueKey":"verdict.quotes.items.[INDEX].outcomes","typeLabel":"object"},"stands":{"type":"boolean","description":"The present answers are the ones quoted.","isRequired":true,"uniqueKey":"verdict.quotes.items.[INDEX].stands","typeLabel":"boolean"},"bound":{"type":"boolean","isRequired":true,"uniqueKey":"verdict.quotes.items.[INDEX].bound","typeLabel":"boolean"},"lapsed_by":{"type":"array","items":{"type":"string","uniqueKey":"verdict.quotes.items.[INDEX].lapsed_by.items.[INDEX]","typeLabel":"string"},"description":"What changed since the quote.","uniqueKey":"verdict.quotes.items.[INDEX].lapsed_by","typeLabel":"string[]"}},"required":["name","outcomes","stands","bound"],"uniqueKey":"verdict.quotes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"verdict.quotes","typeLabel":"object[]"},"unrated":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The outcome’s or referral’s name.","isRequired":true,"uniqueKey":"verdict.unrated.items.[INDEX].name","typeLabel":"string"},"by":{"type":"string","description":"The alias of the used program that declines.","isRequired":true,"uniqueKey":"verdict.unrated.items.[INDEX].by","typeLabel":"string"},"code":{"type":"string","description":"The declining rule’s code.","isRequired":true,"uniqueKey":"verdict.unrated.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"verdict.unrated.items.[INDEX].message","typeLabel":"string"}},"required":["name","by","code","message"],"uniqueKey":"verdict.unrated.items.[INDEX]","typeLabel":"object"},"description":"Outcomes and referral conditions with no value because a program they read declines.","uniqueKey":"verdict.unrated","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"verdict","typeLabel":"object"}},"required":["head","entries","verdict"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"head":123,"entries":[{"seq":123,"at":"\u003cstring>","by":{"role":"\u003cstring>","id":"\u003cstring>"},"event":{"type":"opened"}}],"verdict":{"stage":"Open","outcomes":{},"declines":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","cite":"\u003cunknown>"}],"open":[{"question":"\u003cstring>","kind":"input","role":"\u003cstring>","choices":"\u003cunknown>","because":"\u003cstring>","reads":[{"path":"\u003cstring>","value":"\u003cunknown>"}]}],"referrals":[{"name":"\u003cstring>","state":"Unknown","role":"\u003cstring>","because":"\u003cstring>","lapsed":true,"reads":[{"path":"\u003cstring>","value":"\u003cunknown>"}]}],"invalid":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","cite":"\u003cunknown>"}],"quotes":[{"name":"\u003cstring>","outcomes":{},"stands":true,"bound":true,"lapsed_by":["\u003cstring>"]}],"unrated":[{"name":"\u003cstring>","by":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"efba8a56-8d69-4606-9627-b49687481489":{"description":"Invalid body, or program_role_required: the caller holds several roles and named none.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7e762f54-b92d-4f20-a913-3e33dd4f356d":{"description":"Authentication required.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"94566b23-740e-4174-a3d6-960b6ace94b2":{"description":"The caller cannot read the program, or no_program_role: the caller holds no program role in this workspace, or not the one named. Checked before the engine is called.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"88a081f4-868e-4a24-a9cc-913c6e989b2b":{"description":"The log is not opened on this program, or the caller cannot read it.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"335fdf1d-c208-4d2b-9c39-b60efcd6bdec":{"description":"stale_write: what the write reads changed after basedOn. refusal carries the engine’s STALE refusal. Read again and decide again.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"},"refusal":{"type":"object","properties":{"code":{"type":"string","maxLength":64,"pattern":"^[A-Z][A-Z0-9_]*$","description":"The engine’s refusal code: ALREADY_OPEN, NOT_OPEN, PROGRAM_CHANGED, CLOSED, UNKNOWN_ROLE, NOT_AUTHORIZED, BAD_PATH, INVALID_VALUE, REASON_REQUIRED, NOT_REFERRED, NOT_ANSWERED, NOT_A_TERM, NOT_DECLINABLE, NOT_QUOTABLE, NOT_QUOTED, STALE, or one a newer engine added. STALE is answered as 409, every other code as 422.","isRequired":true,"uniqueKey":"refusal.code","typeLabel":"string"},"message":{"type":"string","maxLength":4000,"description":"What was wrong, and what to do.","isRequired":true,"uniqueKey":"refusal.message","typeLabel":"string"},"candidates":{"type":"array","items":{"type":"string","maxLength":500,"uniqueKey":"refusal.candidates.items.[INDEX]","typeLabel":"string"},"maxItems":200,"description":"What would be accepted here: values, roles or questions.","uniqueKey":"refusal.candidates","typeLabel":"string[]"}},"required":["code","message"],"additionalProperties":false,"description":"The RSL engine’s refusal of the write: its code, message and what would be accepted.","uniqueKey":"refusal","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>","refusal":{"code":"\u003cstring>","message":"\u003cstring>","candidates":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"ff2716fb-4422-4768-8c70-9dcb483229e7":{"description":"command_refused: the engine refused the write; refusal carries its code, message and candidates. Nothing was recorded.","content":{"application/json":{"schema":{"type":"object","required":["code","error"],"properties":{"error":{"type":"string","minLength":1,"description":"Human-readable explanation of the failure.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","minLength":1,"description":"Stable error code. Clients must tolerate unknown future codes.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"location":{"type":"string","enum":["path","query","header","body"],"isRequired":true,"uniqueKey":"details.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"path":{"type":"array","items":{"type":"string","maxLength":64,"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string"},"maxItems":12,"isRequired":true,"uniqueKey":"details.items.[INDEX].path","typeLabel":"string[]"},"code":{"type":"string","enum":["required","invalid_type","invalid_value","unknown_field"],"isRequired":true,"uniqueKey":"details.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"required":["location","path","code","message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"description":"Bounded safe validation issues; may omit some invalid fields.","uniqueKey":"details","typeLabel":"object[]"},"requestId":{"type":"string","minLength":1,"maxLength":128,"description":"Existing server correlation for this HTTP attempt, when available.","uniqueKey":"requestId","typeLabel":"string"},"dataset":{"type":"string","enum":["naic","osha"],"description":"Dataset needed for dataset_not_enabled.","uniqueKey":"dataset","typeLabel":"enum\u003cstring>"},"businessCode":{"type":"string","description":"The rater’s own refusal code, for business_rejection.","uniqueKey":"businessCode","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"Authored or built-in constraint code","isRequired":true,"uniqueKey":"violations.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Authored message for the failed constraint","isRequired":true,"uniqueKey":"violations.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","description":"Input path of the offending value; empty for the request","isRequired":true,"uniqueKey":"violations.items.[INDEX].path","typeLabel":"string"},"value":{"oneOf":[{"description":"Offending input value, size-bounded by the runtime","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"Offending input value, size-bounded by the runtime","type":"null","isRequired":true,"uniqueKey":"violations.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].value","typeLabel":"any | null"},"constraint":{"type":"string","description":"The constraint the value failed, as text","isRequired":true,"uniqueKey":"violations.items.[INDEX].constraint","typeLabel":"string"},"cite":{"oneOf":[{"type":"string","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.0","typeLabel":"string"},{"type":"null","description":"Filing citation of the constraint, when the source cites one","isRequired":true,"uniqueKey":"violations.items.[INDEX].cite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"violations.items.[INDEX].cite","typeLabel":"string | null"}},"required":["code","message","path","value","constraint","cite"],"additionalProperties":false,"uniqueKey":"violations.items.[INDEX]","typeLabel":"object"},"maxItems":256,"description":"Each input constraint the submission failed, for invalid_inputs and business_rejection.","uniqueKey":"violations","typeLabel":"object[]"},"violationsTruncated":{"type":"boolean","description":"True when the rater reported more violations than violations holds.","uniqueKey":"violationsTruncated","typeLabel":"boolean"},"executionId":{"type":"string","description":"The recorded execution of a failed rating, for rater rating failures.","uniqueKey":"executionId","typeLabel":"string"},"accessUrl":{"oneOf":[{"type":"string","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Not currently returned.","uniqueKey":"accessUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"accessUrl","typeLabel":"string\u003curi> | null"},"refusal":{"type":"object","properties":{"code":{"type":"string","maxLength":64,"pattern":"^[A-Z][A-Z0-9_]*$","description":"The engine’s refusal code: ALREADY_OPEN, NOT_OPEN, PROGRAM_CHANGED, CLOSED, UNKNOWN_ROLE, NOT_AUTHORIZED, BAD_PATH, INVALID_VALUE, REASON_REQUIRED, NOT_REFERRED, NOT_ANSWERED, NOT_A_TERM, NOT_DECLINABLE, NOT_QUOTABLE, NOT_QUOTED, STALE, or one a newer engine added. STALE is answered as 409, every other code as 422.","isRequired":true,"uniqueKey":"refusal.code","typeLabel":"string"},"message":{"type":"string","maxLength":4000,"description":"What was wrong, and what to do.","isRequired":true,"uniqueKey":"refusal.message","typeLabel":"string"},"candidates":{"type":"array","items":{"type":"string","maxLength":500,"uniqueKey":"refusal.candidates.items.[INDEX]","typeLabel":"string"},"maxItems":200,"description":"What would be accepted here: values, roles or questions.","uniqueKey":"refusal.candidates","typeLabel":"string[]"}},"required":["code","message"],"additionalProperties":false,"description":"The RSL engine’s refusal of the write: its code, message and what would be accepted.","uniqueKey":"refusal","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"location":"path","path":["\u003cstring>"],"code":"required","message":"\u003cstring>"}],"requestId":"\u003cstring>","dataset":"naic","businessCode":"\u003cstring>","violations":[{"code":"\u003cstring>","message":"\u003cstring>","path":"\u003cstring>","value":"\u003cunknown>","constraint":"\u003cstring>","cite":"\u003cstring>"}],"violationsTruncated":true,"executionId":"\u003cstring>","accessUrl":"\u003cstring>","refusal":{"code":"\u003cstring>","message":"\u003cstring>","candidates":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8930f695-d786-4d9b-9704-ebf48344a56e":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Effective API key. Send Authorization: Bearer sk-eai-...","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d4461ff1-bf63-4ec4-86ec-270ae603f08d":{"url":"https://api.canary.effectiveai.app/api/v2","description":"Canary"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Effective API key. Send Authorization: Bearer sk-eai-...","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Effective API key. Send Authorization: Bearer sk-eai-...","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"effective-ai-canary","siteName":"Effective","title":"Preview a write to a log - Effective","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T23:03:28.315Z","originalFileLocation":"api-reference/your-programs/preview-a-write-to-a-log.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=\"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Effective\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_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/effective-ai-canary/rQBY_xxcuFdHVIQc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview a write to a log - Effective\">\u003cmeta data-mint-head property=\"og:description\" content=\"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Effective\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://effective-ai-canary.mintlify.site/_mintlify/api/og/v2?division=Your+programs\u0026amp;title=Preview+a+write+to+a+log\u0026amp;description=Decides+a+write+as+writeProgramLogCommands+does+and+records+nothing%3A+the+entries+it+would+record+and+the+verdict+after+them%2C+or+the+refusal+it+would+get.+Refusa\u0026amp;theme=a6ec5ec0cb6593183f212b14\u0026amp;signature=36518339b6cc164e155264981dca6403bd42f0db3fe44e7eee21d72b5ff675e0\">\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=\"Preview a write to a log - Effective\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://effective-ai-canary.mintlify.site/_mintlify/api/og/v2?division=Your+programs\u0026amp;title=Preview+a+write+to+a+log\u0026amp;description=Decides+a+write+as+writeProgramLogCommands+does+and+records+nothing%3A+the+entries+it+would+record+and+the+verdict+after+them%2C+or+the+refusal+it+would+get.+Refusa\u0026amp;theme=a6ec5ec0cb6593183f212b14\u0026amp;signature=36518339b6cc164e155264981dca6403bd42f0db3fe44e7eee21d72b5ff675e0\">\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/effective-ai-canary/rQBY_xxcuFdHVIQc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Effective\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/your-programs/preview-a-write-to-a-log.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.canary.effectiveai.app/#organization\",\"name\":\"Effective\",\"url\":\"https://docs.canary.effectiveai.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/effective-ai-canary/XwQAlB9iZgv01g6C/logo/light.svg?fit=max\u0026auto=format\u0026n=XwQAlB9iZgv01g6C\u0026q=85\u0026s=1dea6fc4d5e457e6149af14837c5112e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.canary.effectiveai.app#website\",\"name\":\"Effective\",\"url\":\"https://docs.canary.effectiveai.app\",\"publisher\":{\"@id\":\"https://docs.canary.effectiveai.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log#webpage\",\"url\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log\",\"name\":\"Preview a write to a log\",\"description\":\"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.\",\"dateModified\":\"2026-11-12T23:03:28.315Z\",\"isPartOf\":{\"@id\":\"https://docs.canary.effectiveai.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Your programs\",\"item\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/get-a-log\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview a write to a log\",\"item\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log#apireference\",\"headline\":\"Preview a write to a log\",\"name\":\"Preview a write to a log\",\"description\":\"Decides a write as writeProgramLogCommands does and records nothing: the entries it would record and the verdict after them, or the refusal it would get. Refusals are not kept.\",\"url\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log\",\"mainEntityOfPage\":{\"@id\":\"https://docs.canary.effectiveai.app/api-reference/your-programs/preview-a-write-to-a-log#webpage\"},\"dateModified\":\"2026-11-12T23:03:28.315Z\",\"publisher\":{\"@id\":\"https://docs.canary.effectiveai.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.canary.effectiveai.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Effective\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Effective\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/your-programs/preview-a-write-to-a-log.md","siteName":"Effective","nav":{"global":null,"tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":"/getting-started/overview"}]},{"tab":"Market Directory","pages":[{"title":"Market Directory","href":"/guides"}]},{"tab":"Product Hub","pages":[{"title":"Product Hub","href":"/guides/product-hub"}]},{"tab":"Relativities","pages":[{"title":"Relativities","href":"/relativities"}]},{"tab":"RSL","pages":[{"title":"RSL","href":"/rsl/overview"}]},{"tab":"API Reference","groups":[{"group":"Managed Products","pages":[{"title":"Find products for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/products","href":"/api-reference/managed-products/find-products-for-filing-preparation"},{"title":"Create a product for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/products","href":"/api-reference/managed-products/create-a-product-for-filing-preparation"},{"title":"Get one product for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/products/{id}","href":"/api-reference/managed-products/get-one-product-for-filing-preparation"}]},{"group":"Insurance Types","pages":[{"title":"List NAIC insurance types","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types","href":"/api-reference/insurance-types/list-naic-insurance-types"},{"title":"List subtypes for a NAIC insurance type","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types/{toiCode}/subtypes","href":"/api-reference/insurance-types/list-subtypes-for-a-naic-insurance-type"},{"title":"Get one NAIC insurance type","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types/{id}","href":"/api-reference/insurance-types/get-one-naic-insurance-type"},{"title":"Get one NAIC insurance subtype","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/insurance-types/{toiCode}/subtypes/{id}","href":"/api-reference/insurance-types/get-one-naic-insurance-subtype"}]},{"group":"Companies","pages":[{"title":"Find companies for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/companies","href":"/api-reference/companies/find-companies-for-filing-preparation"},{"title":"Create a company for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/companies","href":"/api-reference/companies/create-a-company-for-filing-preparation"},{"title":"Get one company for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/companies/{id}","href":"/api-reference/companies/get-one-company-for-filing-preparation"}]},{"group":"Jurisdictions","pages":[{"title":"Find jurisdictions for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/jurisdictions","href":"/api-reference/jurisdictions/find-jurisdictions-for-filing-preparation"},{"title":"Create a jurisdiction for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/jurisdictions","href":"/api-reference/jurisdictions/create-a-jurisdiction-for-filing-preparation"},{"title":"Get one jurisdiction for filing preparation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/jurisdictions/{id}","href":"/api-reference/jurisdictions/get-one-jurisdiction-for-filing-preparation"}]},{"group":"Objections","pages":[{"title":"Triage an objection","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/triage","href":"/api-reference/objections/triage-an-objection"},{"title":"Read objection triage progress","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/triage/{requestId}","href":"/api-reference/objections/read-objection-triage-progress"},{"title":"Get a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}","href":"/api-reference/objections/get-a-workspace-objection"},{"title":"Remove a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json delete /objections/{id}","href":"/api-reference/objections/remove-a-workspace-objection"},{"title":"Edit a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json patch /objections/{id}","href":"/api-reference/objections/edit-a-workspace-objection"},{"title":"Get an objection item","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items/{itemId}","href":"/api-reference/objections/get-an-objection-item"},{"title":"Remove an objection item","deprecated":null,"version":null,"openapi":"/openapi.json delete /objections/{id}/items/{itemId}","href":"/api-reference/objections/remove-an-objection-item"},{"title":"Edit an objection item or response draft","deprecated":null,"version":null,"openapi":"/openapi.json patch /objections/{id}/items/{itemId}","href":"/api-reference/objections/edit-an-objection-item-or-response-draft"},{"title":"List the requests in a workspace objection","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items","href":"/api-reference/objections/list-the-requests-in-a-workspace-objection"},{"title":"Add a regulator request to an objection","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/items","href":"/api-reference/objections/add-a-regulator-request-to-an-objection"},{"title":"Upload an objection document","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/uploads","href":"/api-reference/objections/upload-an-objection-document"},{"title":"Confirm an objection document upload","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/uploads/complete","href":"/api-reference/objections/confirm-an-objection-document-upload"},{"title":"List documents attached to an objection","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/documents","href":"/api-reference/objections/list-documents-attached-to-an-objection"},{"title":"Attach an existing file to an objection","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/documents","href":"/api-reference/objections/attach-an-existing-file-to-an-objection"},{"title":"Remove a document from an objection","deprecated":null,"version":null,"openapi":"/openapi.json delete /objections/{id}/documents/{fileId}","href":"/api-reference/objections/remove-a-document-from-an-objection"},{"title":"Read an objection item discussion timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items/{itemId}/comments","href":"/api-reference/objections/read-an-objection-item-discussion-timeline"},{"title":"Comment or reply on an objection item","deprecated":null,"version":null,"openapi":"/openapi.json post /objections/{id}/items/{itemId}/comments","href":"/api-reference/objections/comment-or-reply-on-an-objection-item"},{"title":"Get one objection item comment","deprecated":null,"version":null,"openapi":"/openapi.json get /objections/{id}/items/{itemId}/comments/{commentId}","href":"/api-reference/objections/get-one-objection-item-comment"},{"title":"Edit a comment or resolve its discussion","deprecated":null,"version":null,"openapi":"/openapi.json patch /objections/{id}/items/{itemId}/comments/{commentId}","href":"/api-reference/objections/edit-a-comment-or-resolve-its-discussion"},{"title":"List workspace objections on a filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/objections","href":"/api-reference/objections/list-workspace-objections-on-a-filing"},{"title":"Record an objection letter on a managed filing","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/objections","href":"/api-reference/objections/record-an-objection-letter-on-a-managed-filing"}]},{"group":"Answers","pages":[{"title":"Schedule an answer to a question","deprecated":null,"version":null,"openapi":"/openapi.json post /answers","href":"/api-reference/answers/schedule-an-answer-to-a-question"},{"title":"Get answer status or completed result","deprecated":null,"version":null,"openapi":"/openapi.json get /answers/{id}","href":"/api-reference/answers/get-answer-status-or-completed-result"}]},{"group":"Form comparisons","pages":[{"title":"Validate knowledge files","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/form-knowledge/validate","href":"/api-reference/form-comparisons/validate-knowledge-files"},{"title":"List form comparisons","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/form-comparisons","href":"/api-reference/form-comparisons/list-form-comparisons"},{"title":"Request a form comparison","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/form-comparisons","href":"/api-reference/form-comparisons/request-a-form-comparison"},{"title":"Get a form comparison","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/form-comparisons/{id}","href":"/api-reference/form-comparisons/get-a-form-comparison"},{"title":"Delete a form comparison","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/form-comparisons/{id}","href":"/api-reference/form-comparisons/delete-a-form-comparison"}]},{"group":"Loss reviews","pages":[{"title":"List loss reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/loss-reviews","href":"/api-reference/loss-reviews/list-loss-reviews"},{"title":"Review supplied loss evidence","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/loss-reviews","href":"/api-reference/loss-reviews/review-supplied-loss-evidence"},{"title":"List saved loss matters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/loss-reviews/{id}/items","href":"/api-reference/loss-reviews/list-saved-loss-matters"},{"title":"Get a loss review","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/loss-reviews/{id}","href":"/api-reference/loss-reviews/get-a-loss-review"},{"title":"Delete a loss review","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/loss-reviews/{id}","href":"/api-reference/loss-reviews/delete-a-loss-review"}]},{"group":"Access","pages":[{"title":"Read a resource access list","deprecated":null,"version":null,"openapi":"/openapi.json get /access/{resource}","href":"/api-reference/access/read-a-resource-access-list"},{"title":"Replace a resource access list","deprecated":null,"version":null,"openapi":"/openapi.json put /access/{resource}","href":"/api-reference/access/replace-a-resource-access-list"},{"title":"Change selected resource access","deprecated":null,"version":null,"openapi":"/openapi.json patch /access/{resource}","href":"/api-reference/access/change-selected-resource-access"}]},{"group":"Users","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"/openapi.json get /users/me","href":"/api-reference/users/get-current-user"},{"title":"List organization users","deprecated":null,"version":null,"openapi":"/openapi.json get /users","href":"/api-reference/users/list-organization-users"}]},{"group":"Groups","pages":[{"title":"List groups for sharing","deprecated":null,"version":null,"openapi":"/openapi.json get /groups","href":"/api-reference/groups/list-groups-for-sharing"}]},{"group":"Agent email aliases","pages":[{"title":"List agent email aliases","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-email/aliases","href":"/api-reference/agent-email-aliases/list-agent-email-aliases"},{"title":"Create an agent email alias","deprecated":null,"version":null,"openapi":"/openapi.json post /agent-email/aliases","href":"/api-reference/agent-email-aliases/create-an-agent-email-alias"},{"title":"Get an agent email alias","deprecated":null,"version":null,"openapi":"/openapi.json get /agent-email/aliases/{alias}","href":"/api-reference/agent-email-aliases/get-an-agent-email-alias"},{"title":"Replace alias routing config","deprecated":null,"version":null,"openapi":"/openapi.json put /agent-email/aliases/{alias}","href":"/api-reference/agent-email-aliases/replace-alias-routing-config"},{"title":"Delete an agent email alias","deprecated":null,"version":null,"openapi":"/openapi.json delete /agent-email/aliases/{alias}","href":"/api-reference/agent-email-aliases/delete-an-agent-email-alias"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Read a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json get /webhook-endpoints/{id}","href":"/api-reference/webhooks/read-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhook-endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /webhook-endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/openapi.json post /webhook-endpoints/{id}/test","href":"/api-reference/webhooks/send-a-test-event"}]},{"group":"NAIC statutory data","pages":[{"title":"List a carrier’s state results","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-results","href":"/api-reference/naic-statutory-data/list-a-carrier’s-state-results"},{"title":"Get a carrier state result","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-results/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-state-result"},{"title":"Get a carrier’s annual financial totals","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/financials","href":"/api-reference/naic-statutory-data/get-a-carrier’s-annual-financial-totals"},{"title":"List a carrier’s line results","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/line-results","href":"/api-reference/naic-statutory-data/list-a-carrier’s-line-results"},{"title":"Get a carrier line result","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/line-results/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-line-result"},{"title":"List a carrier’s state license observations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-licenses","href":"/api-reference/naic-statutory-data/list-a-carrier’s-state-license-observations"},{"title":"Get a carrier state license observation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/state-licenses/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-state-license-observation"},{"title":"Get a carrier’s Schedule P interrogatories","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/loss-development/interrogatories","href":"/api-reference/naic-statutory-data/get-a-carrier’s-schedule-p-interrogatories"},{"title":"List a carrier’s Schedule P loss development rows","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/loss-development","href":"/api-reference/naic-statutory-data/list-a-carrier’s-schedule-p-loss-development-rows"},{"title":"Get a carrier Schedule P loss development row","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{carrierId}/loss-development/{id}","href":"/api-reference/naic-statutory-data/get-a-carrier-schedule-p-loss-development-row"}]},{"group":"Carriers","pages":[{"title":"List carriers","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers","href":"/api-reference/carriers/list-carriers"},{"title":"Get a carrier","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carriers/{id}","href":"/api-reference/carriers/get-a-carrier"}]},{"group":"Carrier groups","pages":[{"title":"List carrier groups","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carrier-groups","href":"/api-reference/carrier-groups/list-carrier-groups"},{"title":"Get a carrier group","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/carrier-groups/{id}","href":"/api-reference/carrier-groups/get-a-carrier-group"}]},{"group":"MGAs","pages":[{"title":"List MGAs","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/mgas","href":"/api-reference/mgas/list-mgas"},{"title":"Get an MGA","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/mgas/{id}","href":"/api-reference/mgas/get-an-mga"}]},{"group":"Product types","pages":[{"title":"List shared type definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/types","href":"/api-reference/product-types/list-shared-type-definitions"},{"title":"Get a shared type definition","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/types/{typeId}","href":"/api-reference/product-types/get-a-shared-type-definition"}]},{"group":"Products","pages":[{"title":"Get the products you have access to","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/product-access","href":"/api-reference/products/get-the-products-you-have-access-to"},{"title":"List the lines of business products use","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/product-lines","href":"/api-reference/products/list-the-lines-of-business-products-use"},{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products","href":"/api-reference/products/list-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{id}","href":"/api-reference/products/get-a-product"},{"title":"List recorded product filings in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/filings","href":"/api-reference/products/list-recorded-product-filings-in-a-state"},{"title":"Get recorded product underwriting manuals in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/uw-manuals","href":"/api-reference/products/get-recorded-product-underwriting-manuals-in-a-state"},{"title":"Get recorded product rate manuals in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/rate-manuals","href":"/api-reference/products/get-recorded-product-rate-manuals-in-a-state"},{"title":"Get recorded product forms in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/forms","href":"/api-reference/products/get-recorded-product-forms-in-a-state"},{"title":"Get recorded product marketing in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/marketing","href":"/api-reference/products/get-recorded-product-marketing-in-a-state"},{"title":"List associated product resources","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/resources","href":"/api-reference/products/list-associated-product-resources"},{"title":"Get an associated product resource","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/resources/{resourceId}","href":"/api-reference/products/get-an-associated-product-resource"},{"title":"List your organization's rating plan requests for a product","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/rating-plan-requests","href":"/api-reference/products/list-your-organizations-rating-plan-requests-for-a-product"},{"title":"Request rating plans for product states","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/products/{productId}/rating-plan-requests","href":"/api-reference/products/request-rating-plans-for-product-states"},{"title":"Get your organization's catalog request for a product","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/catalog-requests","href":"/api-reference/products/get-your-organizations-catalog-request-for-a-product"},{"title":"Ask Effective to catalogue a product","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/products/{productId}/catalog-requests","href":"/api-reference/products/ask-effective-to-catalogue-a-product"},{"title":"List which rating program versions rate a product in a state","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/availability/{state}/rating-programs","href":"/api-reference/products/list-which-rating-program-versions-rate-a-product-in-a-state"}]},{"group":"Product timelines","pages":[{"title":"Get a product's timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/timeline","href":"/api-reference/product-timelines/get-a-products-timeline"},{"title":"Get a digest of a product's timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/products/{productId}/timeline/digest","href":"/api-reference/product-timelines/get-a-digest-of-a-products-timeline"}]},{"group":"Market raters","pages":[{"title":"List market raters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs","href":"/api-reference/market-raters/list-market-raters"},{"title":"Get a market rater","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}","href":"/api-reference/market-raters/get-a-market-rater"},{"title":"Subscribe to a market rater","deprecated":null,"version":null,"openapi":"/openapi.json put /insurance/rating-programs/{id}/subscription","href":"/api-reference/market-raters/subscribe-to-a-market-rater"},{"title":"Unsubscribe from a market rater","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/rating-programs/{id}/subscription","href":"/api-reference/market-raters/unsubscribe-from-a-market-rater"},{"title":"Get the input and output schemas of a market rater version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}/contract","href":"/api-reference/market-raters/get-the-input-and-output-schemas-of-a-market-rater-version"},{"title":"Rate a submission with the latest version of a market rater","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/{id}/rate","href":"/api-reference/market-raters/rate-a-submission-with-the-latest-version-of-a-market-rater"},{"title":"Rate a submission with a market rater version","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/{id}/versions/{version}/rate","href":"/api-reference/market-raters/rate-a-submission-with-a-market-rater-version"},{"title":"Plan the next question for market rater versions","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/plan","href":"/api-reference/market-raters/plan-the-next-question-for-market-rater-versions"},{"title":"Match a said or read answer to a planning question","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/match","href":"/api-reference/market-raters/match-a-said-or-read-answer-to-a-planning-question"},{"title":"Search the answers of a planning question","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/rating-programs/search","href":"/api-reference/market-raters/search-the-answers-of-a-planning-question"},{"title":"Search a long list of the latest version of a market rater","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/lists/{name}","href":"/api-reference/market-raters/search-a-long-list-of-the-latest-version-of-a-market-rater"},{"title":"Search a long list of a market rater version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}/lists/{name}","href":"/api-reference/market-raters/search-a-long-list-of-a-market-rater-version"},{"title":"List market rater versions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions","href":"/api-reference/market-raters/list-market-rater-versions"},{"title":"Get a market rater version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}","href":"/api-reference/market-raters/get-a-market-rater-version"},{"title":"Download a market rater version","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/rating-programs/{id}/versions/{version}/download","href":"/api-reference/market-raters/download-a-market-rater-version"}]},{"group":"Filings","pages":[{"title":"Search filings","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/filings/search","href":"/api-reference/filings/search-filings"},{"title":"List catalog filings","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings","href":"/api-reference/filings/list-catalog-filings"},{"title":"Get a catalog filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}","href":"/api-reference/filings/get-a-catalog-filing"},{"title":"List stored filing files","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/files","href":"/api-reference/filings/list-stored-filing-files"},{"title":"List extracted filing forms","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/forms","href":"/api-reference/filings/list-extracted-filing-forms"},{"title":"Get extracted filing rate impact","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/rate-impact","href":"/api-reference/filings/get-extracted-filing-rate-impact"},{"title":"Get one extracted filing form","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filings/{filingId}/forms/{id}","href":"/api-reference/filings/get-one-extracted-filing-form"}]},{"group":"Files","pages":[{"title":"Download one immutable file version","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{fileId}/download","href":"/api-reference/files/download-one-immutable-file-version"},{"title":"Read a bounded chunk of existing extracted text","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{fileId}/text","href":"/api-reference/files/read-a-bounded-chunk-of-existing-extracted-text"},{"title":"Get file metadata and content links","deprecated":null,"version":null,"openapi":"/openapi.json get /files/{fileId}","href":"/api-reference/files/get-file-metadata-and-content-links"}]},{"group":"Managed Filings","pages":[{"title":"Find supporting requirements before creating a filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/requirements","href":"/api-reference/managed-filings/find-supporting-requirements-before-creating-a-filing"},{"title":"Read full supporting requirement instructions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/requirements/{requirementId}","href":"/api-reference/managed-filings/read-full-supporting-requirement-instructions"},{"title":"Find supporting requirements for an existing filing","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/requirements","href":"/api-reference/managed-filings/find-supporting-requirements-for-an-existing-filing"},{"title":"Check staging credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/staging","href":"/api-reference/managed-filings/check-staging-credentials"},{"title":"Authorize and start SERFF staging","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/staging","href":"/api-reference/managed-filings/authorize-and-start-serff-staging"},{"title":"Sync a managed filing from SERFF","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/serff-sync","href":"/api-reference/managed-filings/sync-a-managed-filing-from-serff"},{"title":"Read a filing's regulatory history","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/history","href":"/api-reference/managed-filings/read-a-filings-regulatory-history"},{"title":"List accessible filings","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings","href":"/api-reference/managed-filings/list-accessible-filings"},{"title":"Create a filing","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings","href":"/api-reference/managed-filings/create-a-filing"},{"title":"Read a filing Record","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}","href":"/api-reference/managed-filings/read-a-filing-record"},{"title":"Edit working filing details","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/{filingId}","href":"/api-reference/managed-filings/edit-working-filing-details"},{"title":"List filing items","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/items","href":"/api-reference/managed-filings/list-filing-items"},{"title":"Attach a document to a working filing","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/items","href":"/api-reference/managed-filings/attach-a-document-to-a-working-filing"},{"title":"Get one filing item","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/items/{itemId}","href":"/api-reference/managed-filings/get-one-filing-item"},{"title":"Remove a working filing item","deprecated":null,"version":null,"openapi":"/openapi.json delete /insurance/managed-filings/{filingId}/items/{itemId}","href":"/api-reference/managed-filings/remove-a-working-filing-item"},{"title":"Edit or replace a working document reference","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/{filingId}/items/{itemId}","href":"/api-reference/managed-filings/edit-or-replace-a-working-document-reference"},{"title":"List filing comments","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/comments","href":"/api-reference/managed-filings/list-filing-comments"},{"title":"Add a filing comment or reply","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/comments","href":"/api-reference/managed-filings/add-a-filing-comment-or-reply"},{"title":"Get one filing comment","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/comments/{commentId}","href":"/api-reference/managed-filings/get-one-filing-comment"},{"title":"Edit a comment or update its discussion","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/{filingId}/comments/{commentId}","href":"/api-reference/managed-filings/edit-a-comment-or-update-its-discussion"},{"title":"Upload a filing document","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/uploads","href":"/api-reference/managed-filings/upload-a-filing-document"},{"title":"Confirm a filing document upload","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/uploads/complete","href":"/api-reference/managed-filings/confirm-a-filing-document-upload"}]},{"group":"Managed Filing Checks","pages":[{"title":"List filing checks","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/checks","href":"/api-reference/managed-filing-checks/list-filing-checks"},{"title":"Create an organization filing check","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/checks","href":"/api-reference/managed-filing-checks/create-an-organization-filing-check"},{"title":"Read a filing check","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/checks/{checkId}","href":"/api-reference/managed-filing-checks/read-a-filing-check"},{"title":"Revise filing check instructions","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/managed-filings/checks/{checkId}","href":"/api-reference/managed-filing-checks/revise-filing-check-instructions"},{"title":"Start filing pre-review","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/pre-reviews","href":"/api-reference/managed-filing-checks/start-filing-pre-review"},{"title":"Resume an accepted filing pre-review","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/managed-filings/{filingId}/pre-reviews/{runId}/resume","href":"/api-reference/managed-filing-checks/resume-an-accepted-filing-pre-review"},{"title":"Read the latest filing pre-review","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/pre-reviews/latest","href":"/api-reference/managed-filing-checks/read-the-latest-filing-pre-review"},{"title":"Read filing pre-review progress","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/pre-reviews/{runId}","href":"/api-reference/managed-filing-checks/read-filing-pre-review-progress"},{"title":"Read combined filing check status","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/managed-filings/{filingId}/pre-review-status","href":"/api-reference/managed-filing-checks/read-combined-filing-check-status"}]},{"group":"Filing objections","pages":[{"title":"Find extracted objection letters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filing-objections","href":"/api-reference/filing-objections/find-extracted-objection-letters"},{"title":"Read an extracted objection letter","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/filing-objections/{objectionId}","href":"/api-reference/filing-objections/read-an-extracted-objection-letter"}]},{"group":"Regulatory documents","pages":[{"title":"Find regulatory documents","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents","href":"/api-reference/regulatory-documents/find-regulatory-documents"},{"title":"Get a regulatory document","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents/{documentId}","href":"/api-reference/regulatory-documents/get-a-regulatory-document"},{"title":"Read a regulatory document's text in chunks","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents/{documentId}/text","href":"/api-reference/regulatory-documents/read-a-regulatory-documents-text-in-chunks"},{"title":"List citations out of or into a regulatory document","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-documents/{documentId}/references","href":"/api-reference/regulatory-documents/list-citations-out-of-or-into-a-regulatory-document"},{"title":"List form checklist requirements across states","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-requirements","href":"/api-reference/regulatory-documents/list-form-checklist-requirements-across-states"},{"title":"Get a form checklist requirement","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/regulatory-requirements/{requirementId}","href":"/api-reference/regulatory-documents/get-a-form-checklist-requirement"}]},{"group":"OSHA","pages":[{"title":"Match an employer","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/match","href":"/api-reference/osha/match-an-employer"},{"title":"Get an employer","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}","href":"/api-reference/osha/get-an-employer"},{"title":"List an employer’s sites","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/sites","href":"/api-reference/osha/list-an-employer’s-sites"},{"title":"Get an employer’s site","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/sites/{siteId}","href":"/api-reference/osha/get-an-employer’s-site"},{"title":"List an employer’s events","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/events","href":"/api-reference/osha/list-an-employer’s-events"},{"title":"Get an employer’s OSHA profile","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/employers/{employerId}/osha-profile","href":"/api-reference/osha/get-an-employer’s-osha-profile"},{"title":"List OSHA Form 300A summaries","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/300a-summaries","href":"/api-reference/osha/list-osha-form-300a-summaries"},{"title":"Get an OSHA Form 300A summary","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/300a-summaries/{id}","href":"/api-reference/osha/get-an-osha-form-300a-summary"},{"title":"List OSHA case details","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/case-details","href":"/api-reference/osha/list-osha-case-details"},{"title":"Get an OSHA case detail","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/case-details/{id}","href":"/api-reference/osha/get-an-osha-case-detail"},{"title":"List OSHA severe injury reports","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/severe-injury-reports","href":"/api-reference/osha/list-osha-severe-injury-reports"},{"title":"Get an OSHA severe injury report","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/severe-injury-reports/{id}","href":"/api-reference/osha/get-an-osha-severe-injury-report"},{"title":"List OSHA inspections","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections","href":"/api-reference/osha/list-osha-inspections"},{"title":"Get an OSHA inspection","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}","href":"/api-reference/osha/get-an-osha-inspection"},{"title":"List an inspection’s violations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/violations","href":"/api-reference/osha/list-an-inspection’s-violations"},{"title":"Get a violation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/violations/{citationId}","href":"/api-reference/osha/get-a-violation"},{"title":"List a violation’s history","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/violations/{citationId}/events","href":"/api-reference/osha/list-a-violation’s-history"},{"title":"List an inspection’s related activities","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/inspections/{activityNr}/related-activities","href":"/api-reference/osha/list-an-inspection’s-related-activities"},{"title":"List OSHA accident investigations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/accidents","href":"/api-reference/osha/list-osha-accident-investigations"},{"title":"Get an OSHA accident investigation","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/accidents/{summaryNr}","href":"/api-reference/osha/get-an-osha-accident-investigation"},{"title":"List an accident’s injured workers","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/accidents/{summaryNr}/injuries","href":"/api-reference/osha/list-an-accident’s-injured-workers"},{"title":"Search OSHA narratives","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/search","href":"/api-reference/osha/search-osha-narratives"},{"title":"Get OSHA incidence rates for an industry","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/osha/incidence-rates","href":"/api-reference/osha/get-osha-incidence-rates-for-an-industry"}]},{"group":"SERFF Imports","pages":[{"title":"Open your SERFF import conversation","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-sessions","href":"/api-reference/serff-imports/open-your-serff-import-conversation"},{"title":"Recover a document uploaded by a SERFF import","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-import-items/{id}/uploaded-document","href":"/api-reference/serff-imports/recover-a-document-uploaded-by-a-serff-import"},{"title":"List your saved import selections","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-import-items","href":"/api-reference/serff-imports/list-your-saved-import-selections"},{"title":"Save selected SERFF filings for import","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-items","href":"/api-reference/serff-imports/save-selected-serff-filings-for-import"},{"title":"Read a saved import selection","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-import-items/{id}","href":"/api-reference/serff-imports/read-a-saved-import-selection"},{"title":"Edit your saved import selection","deprecated":null,"version":null,"openapi":"/openapi.json patch /insurance/serff-import-items/{id}","href":"/api-reference/serff-imports/edit-your-saved-import-selection"},{"title":"Cancel a pending import selection","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-items/{id}/cancel","href":"/api-reference/serff-imports/cancel-a-pending-import-selection"},{"title":"Restore a cancelled import selection","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/serff-import-items/{id}/retry","href":"/api-reference/serff-imports/restore-a-cancelled-import-selection"}]},{"group":"SERFF Insurance Types","pages":[{"title":"List current SERFF TOI/sub-TOI combinations","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-insurance-types/combinations","href":"/api-reference/serff-insurance-types/list-current-serff-toisub-toi-combinations"},{"title":"Get a current SERFF TOI/sub-TOI combination","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/serff-insurance-types/combinations/{combinationId}","href":"/api-reference/serff-insurance-types/get-a-current-serff-toisub-toi-combination"}]},{"group":"Your raters","pages":[{"title":"List rater executions","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/executions","href":"/api-reference/your-raters/list-rater-executions"},{"title":"Get a saved rater execution","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/executions/{executionId}","href":"/api-reference/your-raters/get-a-saved-rater-execution"},{"title":"List raters","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters","href":"/api-reference/your-raters/list-raters"},{"title":"Get a rater","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}","href":"/api-reference/your-raters/get-a-rater"},{"title":"Upload a rater bundle","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/raters/{id}/bundles","href":"/api-reference/your-raters/upload-a-rater-bundle"},{"title":"List rater releases","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases","href":"/api-reference/your-raters/list-rater-releases"},{"title":"Release an uploaded rater bundle","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/raters/{id}/releases","href":"/api-reference/your-raters/release-an-uploaded-rater-bundle"},{"title":"Get the input and output schemas of a rater release","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases/{releaseVersion}/contract","href":"/api-reference/your-raters/get-the-input-and-output-schemas-of-a-rater-release"},{"title":"Rate a submission with a rater’s latest release","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/raters/{id}/rate","href":"/api-reference/your-raters/rate-a-submission-with-a-rater’s-latest-release"},{"title":"Rate a submission with a rater release","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance/raters/{id}/releases/{releaseVersion}/rate","href":"/api-reference/your-raters/rate-a-submission-with-a-rater-release"},{"title":"Get a rater release","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases/{releaseVersion}","href":"/api-reference/your-raters/get-a-rater-release"},{"title":"Download a rater release bundle","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance/raters/{id}/releases/{releaseVersion}/download","href":"/api-reference/your-raters/download-a-rater-release-bundle"}]},{"group":"Your programs","pages":[{"title":"Get a log","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/logs/{log}","href":"/api-reference/your-programs/get-a-log"},{"title":"Open a log","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/logs/{log}","href":"/api-reference/your-programs/open-a-log"},{"title":"Write to a log","description":"One write: its commands are recorded together or not at all, decided by the log’s program against the log as the writer read it (basedOn). answer gives an input’s value, or with a referral’s name and Approved or Declined, a sign-off; retract takes one back; quote records a quote of the present answers; bind binds a quote that stands; close closes without a bound quote. option writes in a quote option’s view. A write is refused as stale (409) only when what it reads changed after basedOn; a write elsewhere in the log does not make it stale. Every other refusal is 422 and is kept beside the log. Numbers are kept as written.","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/logs/{log}/commands","href":"/api-reference/your-programs/write-to-a-log"},{"title":"Preview a write to a log","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/logs/{log}/what-if","href":"/api-reference/your-programs/preview-a-write-to-a-log"},{"title":"Get the verdict of a log","description":"What the log’s program says about the answers as of an entry (the head by default), in a quote option’s view if one is named: the stage, the outcomes, what declines, the open questions and who answers each, the referrals and the quotes. A verdict at an entry never changes.","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/logs/{log}/verdict","href":"/api-reference/your-programs/get-the-verdict-of-a-log"},{"title":"Get the answers in a log","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/logs/{log}/answers","href":"/api-reference/your-programs/get-the-answers-in-a-log"},{"title":"List the entries of a log","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/logs/{log}/entries","href":"/api-reference/your-programs/list-the-entries-of-a-log"},{"title":"List the refused writes to a log","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/logs/{log}/refusals","href":"/api-reference/your-programs/list-the-refused-writes-to-a-log"},{"title":"List programs","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl","href":"/api-reference/your-programs/list-programs"},{"title":"Get a program","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}","href":"/api-reference/your-programs/get-a-program"},{"title":"Upload a program bundle","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/uploads","href":"/api-reference/your-programs/upload-a-program-bundle"},{"title":"List program releases","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/releases","href":"/api-reference/your-programs/list-program-releases"},{"title":"Release an uploaded program bundle","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/releases","href":"/api-reference/your-programs/release-an-uploaded-program-bundle"},{"title":"Get a program release","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/releases/{releaseVersion}","href":"/api-reference/your-programs/get-a-program-release"},{"title":"Download a program release bundle","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/releases/{releaseVersion}/download","href":"/api-reference/your-programs/download-a-program-release-bundle"},{"title":"Get the contract of a program release","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/releases/{releaseVersion}/contract","href":"/api-reference/your-programs/get-the-contract-of-a-program-release"},{"title":"Rate with a program release","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/releases/{releaseVersion}/rate","href":"/api-reference/your-programs/rate-with-a-program-release"},{"title":"Get the contract of a used rater of a program release","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/releases/{releaseVersion}/{alias}/contract","href":"/api-reference/your-programs/get-the-contract-of-a-used-rater-of-a-program-release"},{"title":"Rate with a used rater of a program release","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/releases/{releaseVersion}/{alias}/rate","href":"/api-reference/your-programs/rate-with-a-used-rater-of-a-program-release"},{"title":"Get the contract of a program’s latest release","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/contract","href":"/api-reference/your-programs/get-the-contract-of-a-program’s-latest-release"},{"title":"Rate with a program’s latest release","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/rate","href":"/api-reference/your-programs/rate-with-a-program’s-latest-release"},{"title":"Get the contract of a used rater of a program’s latest release","deprecated":null,"version":null,"openapi":"/openapi.json get /rsl/{id}/{alias}/contract","href":"/api-reference/your-programs/get-the-contract-of-a-used-rater-of-a-program’s-latest-release"},{"title":"Rate with a used rater of a program’s latest release","deprecated":null,"version":null,"openapi":"/openapi.json post /rsl/{id}/{alias}/rate","href":"/api-reference/your-programs/rate-with-a-used-rater-of-a-program’s-latest-release"}]},{"group":"Sessions","pages":[{"title":"Retrieve a temporary browser download","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{sessionId}/browsers/{browserId}/downloads/{downloadId}/files/{fileId}","href":"/api-reference/sessions/retrieve-a-temporary-browser-download"},{"title":"Remove a temporary browser download","deprecated":null,"version":null,"openapi":"/openapi.json delete /sessions/{sessionId}/browsers/{browserId}/downloads/{downloadId}","href":"/api-reference/sessions/remove-a-temporary-browser-download"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Start a session with the Effective agent","deprecated":null,"version":null,"openapi":"/openapi.json post /sessions","href":"/api-reference/sessions/start-a-session-with-the-effective-agent"},{"title":"Read a session","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}","href":"/api-reference/sessions/read-a-session"},{"title":"List the conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}/messages","href":"/api-reference/sessions/list-the-conversation"},{"title":"Send a message to a session","deprecated":null,"version":null,"openapi":"/openapi.json post /sessions/{id}/messages","href":"/api-reference/sessions/send-a-message-to-a-session"},{"title":"Read a sent message and its reply","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}/messages/{messageId}","href":"/api-reference/sessions/read-a-sent-message-and-its-reply"},{"title":"List files the agent produced","deprecated":null,"version":null,"openapi":"/openapi.json get /sessions/{id}/files","href":"/api-reference/sessions/list-files-the-agent-produced"}]},{"group":"Skills","pages":[{"title":"Publish a complete immutable team or project skill","deprecated":null,"version":null,"openapi":"/openapi.json post /skills/publications","href":"/api-reference/skills/publish-a-complete-immutable-team-or-project-skill"},{"title":"Download an editable team or project skill snapshot","deprecated":null,"version":null,"openapi":"/openapi.json get /skills/{skillId}/snapshot","href":"/api-reference/skills/download-an-editable-team-or-project-skill-snapshot"},{"title":"Get skill metadata and file manifest","deprecated":null,"version":null,"openapi":"/openapi.json get /skills/{skillId}","href":"/api-reference/skills/get-skill-metadata-and-file-manifest"},{"title":"Delete a published team or project skill","deprecated":null,"version":null,"openapi":"/openapi.json delete /skills/{skillId}","href":"/api-reference/skills/delete-a-published-team-or-project-skill"},{"title":"List available skills","deprecated":null,"version":null,"openapi":"/openapi.json get /skills","href":"/api-reference/skills/list-available-skills"},{"title":"Download a skill for local agents","deprecated":null,"version":null,"openapi":"/openapi.json get /skills/{skillId}/bundle","href":"/api-reference/skills/download-a-skill-for-local-agents"}]},{"group":"Device sign-in","pages":[{"title":"Start a browser sign-in for an agent","deprecated":null,"version":null,"openapi":"/openapi.json post /device-authorizations","href":"/api-reference/device-sign-in/start-a-browser-sign-in-for-an-agent"},{"title":"Check a browser sign-in and receive its API key","deprecated":null,"version":null,"openapi":"/openapi.json post /device-authorizations/exchange","href":"/api-reference/device-sign-in/check-a-browser-sign-in-and-receive-its-api-key"}]},{"group":"Shares","pages":[{"title":"Download a published share attachment","deprecated":null,"version":null,"openapi":"/openapi.json get /shares/{slug}/files/{fileId}/download","href":"/api-reference/shares/download-a-published-share-attachment"}]},{"group":"Filing reviews","pages":[{"title":"Read a filing review from its link","deprecated":null,"version":null,"openapi":"/openapi.json get /filing-reviews/{reviewId}","href":"/api-reference/filing-reviews/read-a-filing-review-from-its-link"},{"title":"Read a filing a review's link covers","deprecated":null,"version":null,"openapi":"/openapi.json get /filing-reviews/{reviewId}/filings/{filingId}","href":"/api-reference/filing-reviews/read-a-filing-a-reviews-link-covers"},{"title":"List objection letters on a filing a review's link covers","deprecated":null,"version":null,"openapi":"/openapi.json get /filing-reviews/{reviewId}/filings/{filingId}/objections","href":"/api-reference/filing-reviews/list-objection-letters-on-a-filing-a-reviews-link-covers"}]}]}]},"basePath":"","title":"Preview a write to a log - Effective","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-CRkbAgbc.js","dist-CI2D8R2Y.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C8f2yC9R.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","AssistantPageLink-k78Wrw_e.js"]}