/programs/{program_id}/frameworks/{framework_id}/schemaRetrieve register schema
Retrieves the schema from the specified register. The lsn and timestamp values cannot be specified at the same time. If both are omitted, the register schema is retrieved from register's head.
Quick start
curl "https://api.optitech.com/v1/programs/$PROGRAM_ID/frameworks/$FRAMEWORK_ID/schema?db_name=$DB_NAME" \
-H "Authorization: Bearer $OPTITECH_API_KEY"Every field below is optional. An empty body works too.
optitech branches schema-diff [base] [compare]Parameters
program_idThe OptiTech program ID
framework_idThe framework ID
db_nameName of the register for which the schema is retrieved
lsnThe Log Sequence Number (LSN) for which the schema is retrieved
timestampThe point in time for which the schema is retrieved
formatThe format of the schema to retrieve. Possible values:
sql(default)json
Response
200Schema definition
Errors
General error
This endpoint can return the standard OptiTech API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.