public

Un type de document : ce qu’il faut collecter, et ce qu’Oslaw remplit lui-même

GET

/v1/document-types/{key}

curl --request GET \
  --url '/v1/document-types/{key}' \
  --header 'Authorization: Bearer <token>'

{
  "example": {
    "ia": {},
    "saisie": {},
    "source": "jeuDEssai"
  },
  "fields": [
    {
      "choices": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ],
      "default": "<any>",
      "fields": [
        "<any>"
      ],
      "help": "<string>",
      "instruction": "<string>",
      "key": "<string>",
      "label": "<string>",
      "nature": "saisie",
      "required": true,
      "requiredIf": "<string>",
      "type": "texte",
      "visibleIf": "<string>"
    }
  ],
  "filledByOslaw": [
    "<string>"
  ],
  "instructions": "<string>",
  "key": "<string>",
  "oslawData": [
    {
      "fallback": "lawyer",
      "help": "<string>",
      "key": "<string>",
      "label": "<string>",
      "requires": "matter",
      "source": "<string>"
    }
  ],
  "title": "<string>",
  "version": 123
}

Autorisations

Authorizationstringheaderobligatoire

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

keystringobligatoire

Réponse

exampleobjectobligatoire

Un exemple complet de values pour render_document.

Afficher child attributes

fieldsobject[]obligatoire

Ce qu’il faut collecter : saisie dans values.saisie, ia dans values.ia.

Afficher child attributes

filledByOslawstring[]obligatoire

Ce qu’Oslaw remplit lui-même : à ne jamais demander ni fournir.

instructionsstring

Consignes du type, écrites par le cabinet.

keystringobligatoire

oslawDataobject[]

Les champs lus dans Oslaw, le contexte que chacun exige, et son repli quand la donnée manque.

Afficher child attributes

titlestringobligatoire

versionintegerobligatoire

Plage requise: 0 < x

Besoin d'aide supplémentaire ? Demander à l'équipe