> ## Documentation Index > Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # Open a log > Opens the log on a release of a program with a guideline entry: writes its Opened entry, pinned to that release, so every later entry is decided by it. A log is opened once; opening it again is refused (422, ALREADY_OPEN). A release whose entry is a rater has no log (409, wrong_component). The caller acts in a program role it holds. ## OpenAPI ````yaml /openapi.json post /rsl/{id}/logs/{log} openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://api.effectiveai.app/api/v2 description: Production security: - bearerAuth: [] paths: /rsl/{id}/logs/{log}: post: tags: - Your programs summary: Open a log description: >- Opens the log on a release of a program with a guideline entry: writes its Opened entry, pinned to that release, so every later entry is decided by it. A log is opened once; opening it again is refused (422, ALREADY_OPEN). A release whose entry is a rater has no log (409, wrong_component). The caller acts in a program role it holds. operationId: openProgramLog parameters: - 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. 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 - 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. 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: $ref: '#/components/schemas/ProgramLogOpenRequest' responses: '200': description: The Opened entry and the verdict after it. content: application/json: schema: $ref: '#/components/schemas/LogWriteResult' '400': description: >- Invalid body, or program_role_required: the caller holds several roles and named none. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': 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: $ref: '#/components/schemas/V2CodedError' '404': description: The caller cannot read the log, or the program has no such release. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '409': 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: $ref: '#/components/schemas/LogRefusedWrite' '422': description: >- command_refused: the engine refused the write; refusal carries its code, message and candidates. Nothing was recorded. content: application/json: schema: $ref: '#/components/schemas/LogRefusedWrite' security: - bearerAuth: [] components: schemas: ProgramLogOpenRequest: type: object properties: releaseVersion: type: integer minimum: 0 exclusiveMinimum: true description: The release to pin the log to, by its release version. role: type: string pattern: ^[a-z_][a-z0-9_]{0,63}$/u description: A role the guideline declares in its Roles, such as uw or manager. required: - releaseVersion additionalProperties: false description: The release of the program in the path to open the log on. LogWriteResult: type: object properties: head: type: integer description: The log’s last entry, after the write. entries: type: array items: $ref: '#/components/schemas/LogEntry' description: The entries the write recorded. verdict: $ref: '#/components/schemas/LogVerdict' required: - head - entries - verdict V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. dataset: type: string enum: - naic - osha description: Dataset needed for dataset_not_enabled. businessCode: type: string description: The rater’s own refusal code, for business_rejection. violations: type: array items: type: object properties: code: type: string description: Authored or built-in constraint code message: type: string description: Authored message for the failed constraint path: type: string description: Input path of the offending value; empty for the request value: nullable: true description: Offending input value, size-bounded by the runtime constraint: type: string description: The constraint the value failed, as text cite: type: string nullable: true description: >- Filing citation of the constraint, when the source cites one required: - code - message - path - value - constraint - cite additionalProperties: false maxItems: 256 description: >- Each input constraint the submission failed, for invalid_inputs and business_rejection. violationsTruncated: type: boolean description: >- True when the rater reported more violations than violations holds. executionId: type: string description: >- The recorded execution of a failed rating, for rater rating failures. accessUrl: type: string nullable: true format: uri description: Not currently returned. required: - code LogRefusedWrite: allOf: - $ref: '#/components/schemas/V2CodedError' - type: object properties: 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. message: type: string maxLength: 4000 description: What was wrong, and what to do. candidates: type: array items: type: string maxLength: 500 maxItems: 200 description: 'What would be accepted here: values, roles or questions.' required: - code - message additionalProperties: false description: >- The RSL engine’s refusal of the write: its code, message and what would be accepted. LogEntry: type: object properties: seq: type: integer description: The entry’s position, from 1. at: type: string description: When the host wrote it. No rule reads it. by: $ref: '#/components/schemas/LogActor' event: type: object properties: type: type: string enum: - opened - answered - signed_off - retracted - quoted - bound - closed description: What happened. required: - type additionalProperties: nullable: true description: The event and its fields, as rsl-log writes them. required: - seq - at - by - event LogVerdict: type: object properties: stage: type: string enum: - Open - Ineligible - Declined - Quotable - Bound - Closed description: Where the submission stands. outcomes: type: object additionalProperties: nullable: true description: The rating outcomes; empty while any is unknown. unrated: type: array items: type: object properties: name: type: string description: The outcome’s or referral’s name. by: type: string description: The alias of the used program that declines. code: type: string description: The declining rule’s code. message: type: string required: - name - by - code - message description: >- Outcomes and referral conditions with no value because a program they read declines. declines: type: array items: type: object properties: code: type: string description: The rule’s code, or the referral’s name. message: type: string path: type: string cite: nullable: true description: A JSON value, as the program reads it. Numbers as written. required: - code - message - path description: Rules and sign-offs that decline. open: type: array items: type: object properties: question: type: string description: An input’s path, or a referral’s name. kind: type: string enum: - input - signoff role: type: string nullable: true description: The lowest role that may answer it. choices: nullable: true description: A JSON value, as the program reads it. Numbers as written. because: type: string reads: type: array items: type: object properties: path: type: string value: nullable: true description: >- A JSON value, as the program reads it. Numbers as written. required: - path required: - question - kind - role description: The questions still open. 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. state: type: string enum: - Unknown - NotReferred - Open - Approved - Declined role: type: string description: The lowest role that may sign it off. because: type: string lapsed: type: boolean description: >- A sign-off was given and no longer counts: a value it reads changed. reads: type: array items: type: object properties: path: type: string value: nullable: true description: >- A JSON value, as the program reads it. Numbers as written. required: - path required: - name - state - role - because - lapsed - reads invalid: type: array items: type: object properties: code: type: string description: The rule’s code, or the referral’s name. message: type: string path: type: string cite: nullable: true description: A JSON value, as the program reads it. Numbers as written. required: - code - message - path description: Answers the contract refuses. quotes: type: array items: type: object properties: name: type: string outcomes: type: object additionalProperties: nullable: true 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. stands: type: boolean description: The present answers are the ones quoted. bound: type: boolean lapsed_by: type: array items: type: string description: What changed since the quote. required: - name - outcomes - stands - bound required: - stage - outcomes - declines - open - referrals - invalid - quotes V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error LogActor: type: object properties: role: type: string description: The program role written in. id: type: string description: 'Who wrote: the user.' required: - role - id securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.