DoculaDevelopersDezvoltatori
API 0.8.0 · BuildVersiune produs 0.33.0
Documentation navigationNavigare documentație

API 0.8.0 · 100 operations

Complete API referenceReferință API completă

Filter the exact released inventory by operation ID, method, path, tag, or purpose. Each result opens a static, version-bound page.Filtrează inventarul publicat după operation ID, metodă, cale, tag sau scop. Fiecare rezultat deschide o pagină statică asociată versiunii.

Operations

100 operations shownoperații afișate

GETgetDetailedReadinessRead administrator-only dependency detailsCitește starea detaliată a dependențelor pentru administrator/api/v1/admin/readinessAdministrationGETgetAnalyticsDecisionSummaryRead one canonical current and previous business cohort decision contractCitește decizia canonică pentru cohortele curentă și anterioară/api/v1/analytics/decision-summaryAnalyticsGETgetAnalyticsFailureContributorsRead bounded canonical contributors to one returned failure groupCitește contributorii canonici ai unui grup de erori/api/v1/analytics/failure-contributorsAnalyticsGETgetAnalyticsProcessingContributorsRead bounded canonical contributors to one returned processing-load bucketCitește contributorii canonici ai unui interval de încărcare/api/v1/analytics/processing-contributorsAnalyticsGETgetAnalyticsSummaryRead bounded workflow aggregates and document-generation capacityCitește agregatele fluxului și capacitatea de generare a documentelor/api/v1/analytics/summaryAnalyticsGETlistAuditEventsList append-only audit evidence with stable cursor paginationListează dovezile de audit cu paginare stabilă prin cursor/api/v1/audit-eventsAuditGETgetCurrentSessionRead the current server-side sessionCitește sesiunea curentă de pe server/api/v1/auth/sessionAuthenticationGETlistCasesList deterministic cases and immutable provenanceListează cazurile deterministe și proveniența lor imuabilă/api/v1/casesCasesGETgetCaseRead a deterministic case payload and immutable provenanceCitește datele și proveniența imuabilă ale unui caz determinist/api/v1/cases/{caseId}CasesGETlistConfigurationDeploymentsList bounded redacted configuration deployment summaries newest firstListează cronologic aplicările de configurație cu date sensibile mascate/api/v1/configuration-deploymentsConfiguration deploymentsGETgetConfigurationDeploymentRead immutable configuration deployment evidenceCitește dovada imuabilă a aplicării unei configurații/api/v1/configuration-deployments/{deploymentId}Configuration deploymentsGETlistContractsList contracts visible to the current roleListează contractele vizibile rolului curent/api/v1/contractsContractsGETgetContractRead a contract and its visible immutable versionsCitește un contract și versiunile sale imuabile vizibile/api/v1/contracts/{contractId}ContractsGETgetRCADemoScenariosRead the exact bounded canonical RCA Submission scenariosCitește scenariile canonice limitate pentru demonstrația RCA/api/v1/demo/rca/scenariosRCA demoGETlistExecutionsList durable executions with bounded cursor paginationListează execuțiile durabile cu paginare prin cursor/api/v1/executionsExecutionsGETgetExecutionRead exact durable execution and ordered step stateCitește execuția durabilă exactă și starea ordonată a etapelor/api/v1/executions/{executionId}ExecutionsGETstreamExecutionEventsReplay persisted execution events and continue as an authorized SSE streamReia evenimentele persistate și continuă fluxul SSE autorizat/api/v1/executions/{executionId}/eventsExecutionsGETlistIngestionModelsList bounded canonical ingestion-model familiesListează familiile canonice de modele de ingestie/api/v1/ingestion-modelsIngestion modelsGETgetIngestionModelBySlugRead one canonical ingestion-model family by exact slugCitește familia modelului de ingestie după identificatorul textual exact/api/v1/ingestion-models/by-slug/{ingestionModelSlug}Ingestion modelsGETgetIngestionModelRead one canonical ingestion-model familyCitește o familie canonică de modele de ingestie/api/v1/ingestion-models/{ingestionModelId}Ingestion modelsGETlistIngestionModelActivationsList bounded ingestion-model activation historyListează istoricul activărilor modelului de ingestie/api/v1/ingestion-models/{ingestionModelId}/activationsIngestion modelsGETgetIngestionModelDraftRead the revisioned ingestion-model draftCitește ciorna revizionată a modelului de ingestie/api/v1/ingestion-models/{ingestionModelId}/draftIngestion modelsGETlistIngestionModelVersionsList bounded immutable ingestion-model versionsListează versiunile imuabile ale modelului de ingestie/api/v1/ingestion-models/{ingestionModelId}/versionsIngestion modelsGETresolveIngestionModelVersionResolve the ingestion-model activation at official object timeRezolvă activarea modelului la momentul oficial al obiectului/api/v1/ingestion-models/{ingestionModelId}/versions:resolveIngestion modelsGETgetIntakeLabHistoryRead persisted executions in the fixed synthetic fixture cohortCitește execuțiile persistate din cohorta fixă de test/api/v1/intake-test-lab/historyRCA demoGETgetIntakeLabCatalogRead the bounded synthetic CLWS scenario catalog and shared-release readinessCitește catalogul sintetic CLWS și starea versiunii comune/api/v1/intake-test-lab/scenariosRCA demoGETgetIntakeLabStatisticsRead measured-only terminal cohort aggregates with sample and window provenanceCitește agregatele terminale măsurate și proveniența ferestrei/api/v1/intake-test-lab/statisticsRCA demoGETlistReleasesList immutable published releasesListează versiunile publicate și imuabile/api/v1/releasesReleasesGETfindPublishedReleaseFind one immutable published release by its exact component identityGăsește o versiune publicată după identitatea exactă a componentelor/api/v1/releases/lookupReleasesGETgetReleaseRead an immutable release manifestCitește manifestul unei versiuni imuabile/api/v1/releases/{releaseId}ReleasesGETlistStorageList successful canonical artifacts through a PostgreSQL projectionListează artefactele canonice reușite din proiecția PostgreSQL/api/v1/storageStorageGETlistSubmissionsList canonical submissions with separate ingestion, processing, and storage outcomesListează solicitările canonice și rezultatele lor distincte/api/v1/submissionsSubmissionsGETlistSubmissionTransformationsList canonical transformation nodes across submissions in stable newest-first orderListează cronologic transformările canonice ale solicitărilor/api/v1/submissions/transformationsSubmissionsGETgetSubmissionGraphRead one transactionally consistent Submission, Ingestion, Processing, and Storage graphCitește graful coerent al solicitării, ingestiei, procesării și stocării/api/v1/submissions/{submissionId}SubmissionsGETgetSubmissionElementRead one element only when it belongs to the SubmissionCitește un element numai dacă aparține solicitării/api/v1/submissions/{submissionId}/elements/{elementId}SubmissionsGETgetSubmissionElementContentRead exact original or canonical intermediate JSON when content is availableCitește conținutul JSON original sau intermediar disponibil/api/v1/submissions/{submissionId}/elements/{elementId}/contentSubmissionsGETstreamSubmissionEventsReplay the persisted aggregate Submission history and continue as an authorized SSE streamReia istoricul solicitării și continuă fluxul SSE autorizat/api/v1/submissions/{submissionId}/eventsSubmissionsGETlistTemplatesList immutable DOCX templatesListează șabloanele DOCX imuabile/api/v1/templatesTemplatesGETgetTemplateRead a template and immutable versionsCitește un șablon și versiunile sale imuabile/api/v1/templates/{templateId}TemplatesGETlistCanonicalTemplateActivationsList bounded template activation historyListează istoricul activărilor șablonului/api/v1/templates/{templateId}/activationsTemplatesGETgetCanonicalTemplateDraftRead the verified revisioned template draft metadataCitește metadatele ciornei verificate a șablonului/api/v1/templates/{templateId}/draftTemplatesGETlistCanonicalTemplateVersionsList bounded immutable template versionsListează versiunile imuabile ale șablonului/api/v1/templates/{templateId}/versionsTemplatesGETresolveCanonicalTemplateVersionResolve the template activation at official object timeRezolvă activarea șablonului la momentul oficial al obiectului/api/v1/templates/{templateId}/versions:resolveTemplatesGETlistCanonicalTransformersList bounded canonical transformer familiesListează familiile canonice de transformatoare/api/v1/transformersTransformersGETgetCanonicalTransformerRead one canonical transformer familyCitește o familie canonică de transformatoare/api/v1/transformers/{transformerId}TransformersGETlistCanonicalTransformerActivationsList bounded transformer activation historyListează istoricul activărilor transformatorului/api/v1/transformers/{transformerId}/activationsTransformersGETgetCanonicalTransformerDraftRead the revisioned canonical transformer draftCitește ciorna revizionată a transformatorului canonic/api/v1/transformers/{transformerId}/draftTransformersGETlistCanonicalTransformerVersionsList bounded immutable transformer versionsListează versiunile imuabile ale transformatorului/api/v1/transformers/{transformerId}/versionsTransformersGETresolveCanonicalTransformerVersionResolve the transformer activation at official object timeRezolvă activarea transformatorului la momentul oficial al obiectului/api/v1/transformers/{transformerId}/versions:resolveTransformersGETlistTransformsList transform definitions visible to the current roleListează transformările vizibile rolului curent/api/v1/transformsTransformersGETgetTransformRead a transform and its visible immutable versionsCitește o transformare și versiunile sale imuabile vizibile/api/v1/transforms/{transformId}TransformersGETgetLivenessReport process liveness and build identityVerifică funcționarea procesului și identitatea versiunii/health/liveHealthGETgetReadinessReport aggregate dependency readinessVerifică disponibilitatea cumulată a dependențelor/health/readyHealthPATCHupdateIngestionModelDraftReplace an ingestion-model draft under a strong revision preconditionÎnlocuiește ciorna modelului de ingestie cu verificarea reviziei/api/v1/ingestion-models/{ingestionModelId}/draftIngestion modelsPATCHupdateCanonicalTransformerDraftReplace a transformer draft under a strong revision preconditionÎnlocuiește ciorna transformatorului cu verificarea reviziei/api/v1/transformers/{transformerId}/draftTransformersPOSTloginCreate a server-side sessionCreează o sesiune pe server/api/v1/auth/loginAuthenticationPOSTlogoutRevoke the current sessionÎnchide sesiunea curentă/api/v1/auth/logoutAuthenticationPOSTchangePasswordChange the current user's passwordSchimbă parola utilizatorului curent/api/v1/auth/passwordAuthenticationPOSTgenerateCaseGenerate and persist a deterministic case from a published contract versionGenerează și salvează un caz determinist dintr-o versiune publicată/api/v1/cases/generateCasesPOSTimportFixtureCaseValidate and idempotently import a canonical fixture caseValidează și importă idempotent un caz canonic de test/api/v1/cases/importCasesPOSTapplyConfigurationDeploymentAtomically apply a canonical configuration deploymentAplică atomic o configurație canonică/api/v1/configuration-deploymentsConfiguration deploymentsPOSTvalidateConfigurationDeploymentDry-run a canonical configuration deployment without writesSimulează aplicarea unei configurații canonice fără scrieri/api/v1/configuration-deployments/validateConfiguration deploymentsPOSTcreateContractCreate a mutable contract draftCreează o ciornă editabilă de contract/api/v1/contractsContractsPOSTvalidateContractDraftValidate JSON Schema Draft 2020-12 contentValidează conținutul JSON Schema Draft 2020-12/api/v1/contracts/{contractId}/validateContractsPOSTcreateContractVersionCreate a sequential immutable contract versionCreează următoarea versiune imuabilă a contractului/api/v1/contracts/{contractId}/versionsContractsPOSTdeprecateContractVersionDeprecate a published immutable contract versionRetrage o versiune publicată și imuabilă a contractului/api/v1/contracts/{contractId}/versions/{versionNumber}/deprecateContractsPOSTpublishContractVersionPublish an immutable contract versionPublică o versiune imuabilă a contractului/api/v1/contracts/{contractId}/versions/{versionNumber}/publishContractsPOSTsubmitExecutionSubmit an idempotent durable execution for an immutable releaseTrimite idempotent o execuție durabilă pentru o versiune imuabilă/api/v1/executionsExecutionsPOSTdownloadExecutionArtifactAuthorize, verify, audit, and download one retained execution artifactAutorizează, verifică, auditează și descarcă un artefact păstrat/api/v1/executions/{executionId}/artifacts/{artifactId}/downloadExecutionsPOSTcreateIngestionModelCreate a revisioned canonical ingestion-model familyCreează o familie revizionată de modele de ingestie/api/v1/ingestion-modelsIngestion modelsPOSTcancelIngestionModelActivationCancel a future unpinned ingestion-model activationAnulează o activare viitoare nefixată a modelului de ingestie/api/v1/ingestion-models/{ingestionModelId}/activations/{activationId}/cancelIngestion modelsPOSTtestIngestionModelTest the exact stored ingestion-model draft and sample without canonical writesTestează ciorna salvată a modelului fără scrieri canonice/api/v1/ingestion-models/{ingestionModelId}/testIngestion modelsPOSTvalidateIngestionModelValidate an ingestion-model definition and sample without canonical writesValidează definiția și exemplul modelului fără scrieri canonice/api/v1/ingestion-models/{ingestionModelId}/validateIngestion modelsPOSTversionIngestionModelFreeze the exact ingestion-model draft revision as an immutable versionFixează revizia exactă a modelului de ingestie ca versiune imuabilă/api/v1/ingestion-models/{ingestionModelId}/versionsIngestion modelsPOSTpublishIngestionModelVersionCalendarAtomically publish and schedule an immutable ingestion-model versionPublică și programează atomic o versiune imuabilă a modelului/api/v1/ingestion-models/{ingestionModelId}/versions/{versionNumber}/publishIngestion modelsPOSTrunIntakeLabScenarioSubmit one canonical synthetic scenario through the shared releaseTrimite un scenariu sintetic canonic prin versiunea comună/api/v1/intake-test-lab/runs/{scenarioId}RCA demoPOSTpublishReleasePublish a legacy document release or an idempotent canonical exact releasePublică idempotent o versiune exactă sau o versiune de document existentă/api/v1/releasesReleasesPOSTvalidateCanonicalReleaseValidate an exact transformation or document release without canonical writesValidează o versiune exactă de transformare sau document fără scrieri canonice/api/v1/releases/validateReleasesPOSTcreateSubmissionPersist an idempotent source submission and run its internal ingestion decisionSalvează idempotent o solicitare și execută decizia internă de ingestie/api/v1/submissionsSubmissionsPOSTcreateTemplateCreate a canonical template family with JSON or preserve the legacy immediate multipart uploadCreează o familie canonică de șabloane sau păstrează încărcarea multipart existentă/api/v1/templatesTemplatesPOSTcancelCanonicalTemplateActivationCancel a future unpinned template activationAnulează o activare viitoare nefixată a șablonului/api/v1/templates/{templateId}/activations/{activationId}/cancelTemplatesPOSTupdateCanonicalTemplateDraftUpload and verify the next mutable template draft under a strong revision preconditionÎncarcă și verifică următoarea ciornă a șablonului cu verificarea reviziei/api/v1/templates/{templateId}/draft-contentTemplatesPOSTtestCanonicalTemplateDraftCompose DOCX and PDF probes without retaining output or canonical writesCompune probe DOCX și PDF fără a păstra rezultatele/api/v1/templates/{templateId}/testTemplatesPOSTvalidateCanonicalTemplateDraftValidate the verified template draft without canonical writesValidează ciorna verificată a șablonului fără scrieri canonice/api/v1/templates/{templateId}/validateTemplatesPOSTcreateTemplateVersionFreeze the canonical draft with JSON or preserve the legacy immediate multipart uploadFixează ciorna canonică sau păstrează încărcarea multipart existentă/api/v1/templates/{templateId}/versionsTemplatesPOSTpreviewTemplateVersionResolve template bindings against a deterministic transformed caseRezolvă legăturile șablonului folosind un caz transformat determinist/api/v1/templates/{templateId}/versions/{versionNumber}/previewTemplatesPOSTpublishCanonicalTemplateVersionAtomically publish and schedule an immutable template versionPublică și programează atomic o versiune imuabilă a șablonului/api/v1/templates/{templateId}/versions/{versionNumber}/publishTemplatesPOSTcreateCanonicalTransformerCreate a revisioned canonical transformer familyCreează o familie revizionată de transformatoare canonice/api/v1/transformersTransformersPOSTcancelCanonicalTransformerActivationCancel a future unpinned transformer activationAnulează o activare viitoare nefixată a transformatorului/api/v1/transformers/{transformerId}/activations/{activationId}/cancelTransformersPOSTtestCanonicalTransformerExecute declarative-v1 deterministically without canonical writesExecută deterministic sursa declarative-v1 fără scrieri canonice/api/v1/transformers/{transformerId}/testTransformersPOSTvalidateCanonicalTransformerValidate declarative-v1 source without canonical writesValidează sursa declarative-v1 fără scrieri canonice/api/v1/transformers/{transformerId}/validateTransformersPOSTversionCanonicalTransformerFreeze the exact transformer draft revision as an immutable versionFixează revizia exactă a transformatorului ca versiune imuabilă/api/v1/transformers/{transformerId}/versionsTransformersPOSTpublishCanonicalTransformerVersionAtomically publish and schedule an immutable transformer versionPublică și programează atomic o versiune imuabilă a transformatorului/api/v1/transformers/{transformerId}/versions/{versionNumber}/publishTransformersPOSTcreateTransformCreate a mutable declarative transform draftCreează o ciornă editabilă de transformare declarativă/api/v1/transformsTransformersPOSTpreviewTransformEvaluate unsaved declarative-v1 source against an immutable caseEvaluează sursa declarative-v1 nesalvată pe un caz imuabil/api/v1/transforms/{transformId}/previewTransformersPOSTvalidateTransformDraftValidate declarative-v1 source without persisting a versionValidează sursa declarative-v1 fără a salva o versiune/api/v1/transforms/{transformId}/validateTransformersPOSTcreateTransformVersionCreate a sequential immutable transform versionCreează următoarea versiune imuabilă a transformării/api/v1/transforms/{transformId}/versionsTransformersPOSTpublishTransformVersionPublish an immutable transform versionPublică o versiune imuabilă a transformării/api/v1/transforms/{transformId}/versions/{versionNumber}/publishTransformersPUTupdateContractDraftUpdate a contract draft using optimistic concurrencyActualizează o ciornă de contract cu verificarea reviziei/api/v1/contracts/{contractId}ContractsPUTupdateTransformDraftUpdate a transform draft using optimistic concurrencyActualizează ciorna transformării cu verificarea reviziei/api/v1/transforms/{transformId}Transformers

API conventions

Authentication, sessions, and host isolationAutentificare, sesiuni și izolarea hosturilor

Authenticate on the exact host you intend to use. Sessions are host-only cookies scoped to docula.ro, and copied examples use $COOKIE_JAR rather than a browser token store.Autentifică-te pe hostul exact pe care îl vei folosi. Sesiunile sunt cookie-uri legate strict de hostul docula.ro, iar exemplele copiate folosesc $COOKIE_JAR, nu un token stocat în browser.

Origin, Referer, and CSRFOrigin, Referer și CSRF

Protected browser mutations require the exact Origin or Referer accepted for that host and the X-CSRF-Token bound to the current session. A role never bypasses request-integrity checks.Mutațiile protejate din browser cer valoarea exactă Origin sau Referer acceptată pentru host și X-CSRF-Token asociat sesiunii curente. Rolul nu ocolește verificările de integritate.

Roles and authorizationRoluri și autorizare

Roles apply only after the forced-password state is cleared. While must_change_password is true, only session read, password change, and logout are authorized; all other operations return 403 regardless of role. Authorization is enforced by the Go API.Rolurile se aplică numai după ieșirea din starea de schimbare obligatorie a parolei. Cât timp must_change_password este true, sunt permise doar citirea sesiunii, schimbarea parolei și deconectarea; toate celelalte operații răspund cu 403 indiferent de rol. Autorizarea este aplicată de API-ul Go.

RFC 9457 problemsProbleme RFC 9457

Errors use application/problem+json. Read the HTTP status, stable problem code, correlation identifier, and field pointers before choosing a recovery action.Erorile folosesc application/problem+json. Citește statusul HTTP, codul stabil, identificatorul de corelare și pointerii câmpurilor înainte de a alege recuperarea.

Idempotent replayReluare idempotentă

Where documented, reuse the same Idempotency-Key only for the same logical request. A changed payload requires a new key; a safe replay returns the canonical prior result.Acolo unde este documentat, refolosește același Idempotency-Key doar pentru aceeași cerere logică. Un payload schimbat cere o cheie nouă; reluarea sigură întoarce rezultatul canonic anterior.

ETags and strong preconditionsETag și precondiții ferme

Read the current strong ETag and send it unchanged in If-Match for revisioned mutations. A stale value fails explicitly and never overwrites newer work.Citește ETag-ul ferm curent și trimite-l neschimbat în If-Match pentru mutațiile cu revizie. O valoare expirată eșuează explicit și nu suprascrie lucrul mai nou.

Stable paginationPaginare stabilă

Follow the contract's cursor and limit fields. Preserve filters while advancing; do not infer a total or ordering that the response does not guarantee.Urmează câmpurile cursor și limit din contract. Păstrează filtrele la avansare și nu deduce un total sau o ordine pe care răspunsul nu le garantează.

SSE resume and deduplicationReluare și deduplicare SSE

Persist the latest event identifier and reconnect with Last-Event-ID. Deduplicate by the canonical event identity, then reconcile terminal state with the execution resource.Păstrează ultimul identificator de eveniment și reconectează-te cu Last-Event-ID. Deduplică după identitatea canonică, apoi reconciliază starea terminală cu resursa execuției.

Authorized downloadsDescărcări autorizate

Retrieve DOCX and PDF artifacts only through the documented download endpoint and current host-local session. Object-store keys are evidence, not public URLs.Descarcă artefactele DOCX și PDF doar prin endpointul documentat și sesiunea curentă a hostului. Cheile din object storage sunt dovezi, nu URL-uri publice.

Body and resource limitsLimite pentru body și resurse

Respect the operation-specific request, response, stream, and artifact limits before sending bytes. A missing measurement is unavailable, never zero or unlimited.Respectă limitele specifice operației pentru cereri, răspunsuri, fluxuri și artefacte înainte de a trimite bytes. O măsurătoare lipsă este indisponibilă, nu zero sau nelimitată.

Effective time and receipt timeTimp efectiv și timp de primire

object_effective_at selects eligible immutable configuration. received_at records when Docula accepted the submission; it does not replace business effective time.object_effective_at selectează configurația imuabilă eligibilă. received_at înregistrează când Docula a acceptat solicitarea; nu înlocuiește timpul efectiv de business.

Immutable versionsVersiuni imuabile

Published contract, transformer, template, ingestion-model, and release versions never change. New content creates a new version and preserves prior evidence.Versiunile publicate de contract, transformer, template, ingestion model și release nu se schimbă. Conținutul nou creează o versiune nouă și păstrează dovezile anterioare.

Configuration lifecycle orderOrdinea ciclului de configurare

Create the contract version, deterministic case, transformer version, template version, ingestion-model version, release, and configuration deployment in that dependency order before submitting work.Creează în ordine versiunea contractului, cazul determinist, versiunea transformerului, versiunea template-ului, versiunea modelului de ingestie, release-ul și deploymentul configurației înainte de a trimite solicitări.