Analyser un document

POST

/documents/{document}/analyses

curl --request POST \
  --url https://example.com/documents/example/analyses \
  --header 'Authorization: Bearer <token>'

Chaque analyse est une entité DE PLUS, datée et versionnée par son outillage. Les gestes proposés sont exactement des gestes du composant — jamais inventés, jamais une publication de valeur.

Autorisations

• authentification
  instruments:administration

Paramètres

Paramètres (path)

document

required

string

>= 1 characters

Réponses

201

L’analyse est produite.

Media typeapplication/json

object

analyse

required

string

document

required

string

outillage

required

Qui a extrait — l’analyseur est un adaptateur versionné

string

version_outillage

required

string

produite_le

required

string format: date-time

examinee

required

Vrai quand chaque geste a son sort — l’examen partiel est visible.

boolean

gestes

required

Array<object>

object

numero

required

integer

>= 1

geste_vise

required

Exactement l’un des gestes du composant — jamais un geste inventé, JAMAIS une publication de valeur (un document n’établit pas une VL).

string

Allowed values: referencer_un_instrument referencer_un_vehicule etablir_une_caracteristique reetablir_une_caracteristique poser_une_restriction lever_une_restriction etablir_la_regle_de_valorisation nouer_une_relation affecter_un_role annoncer_un_evenement

rapprochement

required

Le conforme ne produit pas de geste applicable — il constate, et vaut confirmation datée.

string

Allowed values: nouveau ecart conforme

donnees_extraites

required

Aux types du modèle — l’extraction qui ne sait pas produire le type ne propose pas.

object

localisation

required

Ce que le valideur lira en face du geste.

object

page

integer

section

string

extrait

string

indice_confiance_pb

L’indice de confiance de l’extraction, en points de base — le tri à l’examen, jamais un seuil d’application automatique.

integer

<= 10000

sort

string

Allowed values: a_examiner applique amende_puis_applique ecarte

motif

Le motif de l’écart

string

valideur

string

Example

{
  "gestes": [
    {
      "geste_vise": "referencer_un_instrument",
      "rapprochement": "nouveau",
      "sort": "a_examiner"
    }
  ]
}

401

Aucune identité présentée.

403

L’identité présentée n’a pas la famille d’accès instruments:administration.

404

La ressource est inconnue de ce tenant — rien n’existe à travers la muraille.

Media typeapplication/json

object

motif

required

Le motif

string

Example^generated

{
  "motif": "example"
}

422

Le domaine refuse (invariant violé : chevauchement de périodes, inapplicable à la nature, cycle qui n’admet pas la transition, rang déjà publié, préparateur valideur…) — rien n’est retenu, aucun fait n’existe ; le motif nomme l’invariant.

Media typeapplication/json

object

motif

required

Le motif

string

Example^generated

{
  "motif": "example"
}