Aller au contenu

Développeurs

Schémas

Objets échangés par l'API, champ par champ.

Problem object

Erreur RFC 9457.

  • typestring (uri)requis

  • titlestringrequis

  • statusintegerrequis

  • codestringrequis

    Code stable, en majuscules. Liste ouverte : un nouveau code peut apparaître dans la v1 ; traiter un code inconnu d'après le statut HTTP.

    Valeurs : VALIDATION · UNAUTHORIZED · INVALID_API_KEY · SCOPE_MISSING · API_KEY_ROUTE_FORBIDDEN · PLAN_REQUIRED · PLAN_READ_ONLY · NOT_FOUND · IDEMPOTENCY_KEY_REUSED · CONFLICT · FILE_TOO_LARGE · RATE_LIMITED · QUOTA_EXCEEDED · BUSY · INTERNAL_ERROR · GONE · TEMPLATE_NOT_FOUND · TEMPLATE_RESERVED

  • detailstring

  • instancestring

  • errorsobject[]

    Détail par champ, pour VALIDATION.

Page object

  • dataany[]requis

  • next_cursorstring | nullrequis

    À passer en cursor pour la page suivante ; nul en fin de liste.

  • has_morebooleanrequis

ProcessingStatus string

STANDBY en attente d'un déclencheur, READY_FOR_PROCESSING prêt, QUEUED en file, PROCESSING en cours, COMPLETE terminé, ERROR en échec.

Valeurs : STANDBY · READY_FOR_PROCESSING · QUEUED · PROCESSING · COMPLETE · ERROR

Organization object

Organisation (tenant) à laquelle une clé est rattachée.

  • idstring (uuid)requis

  • namestring | nullrequis

    Nom affiché de l'organisation ; null s'il n'a jamais été renseigné.

Project object

  • idstring (uuid)requis

  • namestringrequis

  • descriptionstring | null

  • space_idstring (uuid) | null

    Espace (regroupement de projets) qui contient le projet.

  • space_namestring | null

    Nom de l'espace ; distingue deux projets de même nom rangés dans des espaces différents.

  • space_pathstring | null

    Chemin de l'espace dans l'arborescence de l'organisation, par exemple ~/SNCF.

  • model_countinteger

  • requirement_set_countinteger

  • start_datestring (date-time) | null

  • end_datestring (date-time) | null

  • created_atstring (date-time)requis

  • updated_atstring (date-time)requis

ModelUpdate object

  • namestringrequis

RevisionUpdate object

  • milestonestring | nullrequis

    Jalon (APS, APD, PRO, EXE…) ; null le retire.

ProjectCreate object

  • namestringrequis

  • descriptionstring | null

  • space_idstring (uuid) | null

    Espace de l'organisation (space_id d'un projet) ; racine si absent.

  • start_datestring (date-time) | null

  • end_datestring (date-time) | null

    Postérieure ou égale à start_date.

ProjectUpdate object

  • namestring

  • descriptionstring | null

  • space_idstring (uuid) | null

    null range le projet à la racine de l'organisation.

  • start_datestring (date-time) | null

  • end_datestring (date-time) | null

Model object

  • idstring (uuid)requis

  • namestringrequis

  • formatstringrequis

    Valeurs : IFC · REVIT

  • revision_countintegerrequis

  • latest_revision_idstring (uuid) | null

  • created_atstring (date-time)requis

  • updated_atstring (date-time)requis

ModelProject object

  • idstring (uuid)requis

  • namestringrequis

  • space_pathstring | nullrequis

    Chemin de l'espace du projet, par exemple ~/SNCF ; distingue deux projets de même nom.

ModelSearchItem Model & object

Maquette trouvée par la recherche d'organisation, avec les projets qui la contiennent.

  • idstring (uuid)requis

  • namestringrequis

  • formatstringrequis

    Valeurs : IFC · REVIT

  • revision_countintegerrequis

  • latest_revision_idstring (uuid) | null

  • created_atstring (date-time)requis

  • updated_atstring (date-time)requis

  • projectsModelProject[]requis

    Projets de l'organisation qui contiennent la maquette, triés par nom ; vide si aucun.

ModelCreate object

  • namestringrequis

  • upload_idstring (uuid)requis

    Dépôt clos (purpose: model).

StepStatus object

  • statusProcessingStatusrequis

  • percent_completenumber | null

  • eta_secondsnumber | null

  • error_messagestring | null

Revision object

  • idstring (uuid)requis

  • model_idstring (uuid)requis

  • versionintegerrequis

  • milestonestring | null

    Jalon (APS, APD, PRO, EXE…).

  • file_namestring | null

  • size_bytesinteger | null

  • ifc_schemastring | null

    Ex. IFC2X3, IFC4, IFC4X3_ADD2.

  • authoring_softwarestring | null

  • statusProcessingStatusrequis

    État global, le moins avancé des étapes.

  • processingobjectrequis

  • object_countinteger | null

    Nombre d'objets du jeu de données ; nul tant que dataset n'est pas COMPLETE, et nul quand il est inconnu (jamais 0 par défaut).

  • created_atstring (date-time)requis

RevisionCreate object

  • upload_idstring (uuid)requis

  • milestonestring

IdsSpecificationResult object

  • indexintegerrequis

  • namestringrequis

  • descriptionstring | null

    Description de la spécification dans le fichier IDS, quand l'IDS en a une.

  • statusstringrequis

    NA : sans objet pour cette maquette, non compté dans le score.

    Valeurs : PASS · PARTIAL · FAIL · NA · MISMATCH

  • applicablebooleanrequis

    Compté dans le score. Seul critère d'applicabilité, jamais entity_count_applicable > 0.

  • score_percentnumber | null

  • entity_count_applicableinteger

  • entity_count_validinteger

  • entity_count_invalidinteger

IdsResult object

  • requirement_set_idstring (uuid)requis

  • requirement_set_revision_idstring (uuid)requis

  • statusProcessingStatusrequis

  • score_percentnumber | null

  • specification_countinteger | null

  • specification_count_applicableinteger | null

  • specification_count_failedinteger | null

  • completed_atstring (date-time) | null

    Fin du contrôle ; nul tant qu'il n'est pas terminé, et pour un contrôle ancien dont la date n'a pas été enregistrée (son résultat reste valable).

  • specificationsIdsSpecificationResult[]

    Vide tant que status n'est pas COMPLETE.

IdsFacet object

Facette IDS ; seuls les champs que la facette porte sont rendus.

  • typestringrequis

    Valeurs : ENTITY · ATTRIBUTE · PROPERTY · CLASSIFICATION · MATERIAL · PART_OF

  • cardinalitystring

    Exigences seulement.

    Valeurs : required · optional · prohibited

  • entitystring

    Classe IFC (ENTITY, PART_OF) ; une liste est rendue « one of A | B ».

  • predefined_typestring

  • property_setstring

  • namestring

    Nom de l'attribut ou de la propriété.

  • valuestring

    Valeur attendue : simple, ou la restriction décrite (« pattern L[0-9]{3} », « >= 0 »).

  • data_typestring

  • systemstring

    Système de classification.

  • relationstring

  • instructionsstring

IdsObjectCheck object

  • requirementintegerrequis

    Position dans requirements.

  • statestringrequis

    MISSING absente de l'objet et de son type, EMPTY présente sans valeur, PRESENT renseignée (voir value), NOT_CHECKED facette que les tables ne permettent pas de lire (classification, matériau, motif de nom…).

    Valeurs : MISSING · EMPTY · PRESENT · NOT_CHECKED

  • valuestring | null

  • value_matchesboolean | null

    La valeur respecte la contrainte de la facette ; nul si la facette n'en pose pas ou si la réponse n'est pas sûre.

  • sourcestring | null

    Valeurs : object · type · null

IdsInvalidObject object

  • object_idintegerrequis

    Identifiant de l'objet dans le fichier IFC (#123).

  • global_idstring | null

  • namestring | null

  • ifc_classstring | null

  • checksIdsObjectCheck[]requis

IdsSpecificationFailure object

  • indexintegerrequis

  • namestringrequis

  • descriptionstring | null

  • instructionsstring | null

  • identifierstring | null

  • statusstringrequis

    Valeurs : PASS · PARTIAL · FAIL · NA · MISMATCH

  • applicablebooleanrequis

  • cardinalitystring | null

    required : la maquette doit contenir de tels objets ; prohibited : elle ne doit pas en contenir.

    Valeurs : required · optional · prohibited · null

  • failurestringrequis

    MISSING_OBJECTS aucun objet visé alors que l'IDS en exige, PROHIBITED_OBJECTS des objets interdits sont présents, APPLICABILITY_MISMATCH la classe existe mais aucun objet ne répond à l'applicabilité, INVALID_OBJECTS des objets visés ne respectent pas les exigences, NONE la spécification passe, NOT_APPLICABLE sans objet.

    Valeurs : MISSING_OBJECTS · PROHIBITED_OBJECTS · APPLICABILITY_MISMATCH · INVALID_OBJECTS · NONE · NOT_APPLICABLE

  • score_percentnumber | null

  • entity_count_applicableinteger

  • entity_count_invalidinteger

  • applicabilityIdsFacet[]requis

  • requirementsIdsFacet[]requis

  • invalid_objectsIdsInvalidObject[]requis

  • invalid_objects_totalinteger | null

    Objets en échec listés par le contrôle ; nul si la liste n'est pas disponible.

IdsFailures object

  • revision_idstring (uuid)requis

  • requirement_set_idstring (uuid)requis

  • requirement_set_revision_idstring (uuid)requis

  • statusProcessingStatusrequis

  • completed_atstring (date-time) | null

    Fin du contrôle ; nul tant qu'il n'est pas terminé, et pour un contrôle ancien dont la date n'a pas été enregistrée (son résultat reste valable).

  • definitions_availableboolean

  • details_availableboolean

  • object_data_availableboolean

  • dataIdsSpecificationFailure[]requis

  • next_cursorstring | null

  • has_morebooleanrequis

IdsFailuresBcf object

  • revision_idstring (uuid)requis

  • requirement_set_idstring (uuid)requis

  • requirement_set_revision_idstring (uuid)requis

  • statusProcessingStatusrequis

  • completed_atstring (date-time) | null

    Fin du contrôle ; nul tant qu'il n'est pas terminé, et pour un contrôle ancien dont la date n'a pas été enregistrée (son résultat reste valable).

  • details_availablebooleanrequis

  • topic_countintegerrequis

  • file_namestring | null

  • size_bytesinteger | null

  • download_urlstring (uri) | null

  • download_expires_atstring (date-time) | null

ObjectRow object

  • object_idintegerrequis

  • global_idstring | null

  • namestring | null

  • ifc_classstring | null

  • statestring | null

    Nul sans propriété ni attribut demandés.

    Valeurs : MISSING · EMPTY · PRESENT · null

  • valuestring | null

  • value_sourcestring | null

    Valeurs : object · type · null

ObjectPage object

  • revision_idstring (uuid)requis

  • dataObjectRow[]requis

  • next_cursorstring | nullrequis

  • has_morebooleanrequis

  • totalinteger | null

  • value_countsobject[]

    Présent avec count_values=true sur la première page ; les valeurs les plus fréquentes d'abord.

  • distinct_value_countinteger

    Nombre de lignes de value_counts avant la coupe à 50.

IdsSummary object

  • project_idstring (uuid)requis

  • model_countintegerrequis

  • model_count_checkedinteger

  • model_count_in_progressinteger

  • model_count_errorinteger

  • score_percentnumber | null

    Moyenne des maquettes contrôlées ; nul si aucune.

  • by_requirement_setobject[]

  • computed_atstring (date-time)requis

RequirementSet object

  • idstring (uuid)requis

  • namestringrequis

  • formatstringrequis

    Valeurs : IDS · SEVEUP

  • scopestringrequis

    Portée du jeu (organisation, espace ou projet).

    Valeurs : ORGANIZATION · SPACE · PROJECT

  • scope_idstring (uuid) | null

  • latest_revision_idstring (uuid) | null

  • specification_countinteger | null

  • created_atstring (date-time)requis

  • updated_atstring (date-time)requis

RequirementSetSpecification object

  • indexintegerrequis

    Position dans le fichier

  • namestringrequis

  • descriptionstring | null

  • instructionsstring | null

  • identifierstring | null

  • cardinalitystring | null

    required : la maquette doit contenir de tels objets ; prohibited : elle ne doit pas en contenir.

    Valeurs : required · optional · prohibited · null

  • applicabilityIdsFacet[]requis

  • requirementsIdsFacet[]requis

RequirementSetSpecifications object

  • requirement_set_idstring (uuid)requis

  • requirement_set_revision_idstring (uuid) | null

    Nul si le jeu n'a aucune version.

  • versioninteger | null

  • namestringrequis

  • formatstringrequis

    Valeurs : IDS · SEVEUP

  • specifications_availablebooleanrequis

    Le fichier de cette version a été lu comme un IDS.

  • specification_countinteger | null

  • dataRequirementSetSpecification[]requis

  • next_cursorstring | null

  • has_morebooleanrequis

RequirementSetCreate object

  • namestringrequis

  • upload_idstring (uuid)requis

    Dépôt clos (purpose: ids), fichier .ids ou .xlsx.

  • project_idstring (uuid)

    Lie le jeu à ce projet ; sinon portée organisation.

  • space_idstring (uuid)

    Range le jeu dans cet espace (portée espace) ; exclusif de project_id.

Space object

  • idstring (uuid)requis

  • namestringrequis

  • parent_idstring (uuid) | nullrequis

    Espace parent ; nul à la racine.

  • pathstring | nullrequis

    Chemin dans l'arborescence de l'organisation, par exemple ~/SNCF/LNPCA_SYNTHESE.

  • archivedbooleanrequis

    Espace archivé dans l'App ; on n'y crée plus rien.

  • project_countintegerrequis

    Projets non archivés rangés dans l'espace.

  • created_atstring (date-time) | nullrequis

    Nul pour les espaces créés avant que l'App ne date les espaces.

DashboardTemplate object

  • idstring (uuid)requis

  • namestringrequis

  • descriptionstring | null

  • formatstringrequis

    Valeurs : HTML · POWER_BI

  • reservedbooleanrequis

    Réservé

  • published_atstring (date-time) | null

Dashboard object

  • idstring (uuid)requis

  • namestringrequis

  • descriptionstring | null

  • formatstringrequis

    Valeurs : HTML · POWER_BI

  • space_idstring (uuid) | null

  • template_idstring (uuid) | null

    Modèle d'où le tableau de bord a été copié ; nul s'il a été déposé directement.

  • created_atstring (date-time)requis

  • render_urlstring (uri)requis

    Page de l'App qui affiche le tableau de bord, dans la langue du compte qui a créé la clé (session de l'App requise, jamais la clé d'API).

DashboardCreate object

  • namestringrequis

  • template_idstring (uuid)requis

    Modèle du catalogue (GET /api/v1/dashboard-templates) ou tableau de bord de l'organisation.

SpaceRequirementSet object

  • requirement_set_idstring (uuid)requis

IdsCheckCreate object

  • revision_idstring (uuid)requis

  • requirement_set_idstring (uuid)requis

ExportCreate object

  • tablesstring[]

    Tables à inclure ; toutes par défaut.

  • formatstring

    Format des fichiers de l'archive.

    Valeurs : csv · json

UploadCreate object

  • file_namestringrequis

  • size_bytesintegerrequis

    Taille du fichier en octets. Au-delà de la limite du plan (3 Gio au plus), réponse 413.

  • purposestringrequis

    model pour une maquette IFC, ids pour un jeu d'exigences.

    Valeurs : model · ids

Upload object

  • idstring (uuid)requis

  • statusstringrequis

    Valeurs : PENDING · COMPLETE

  • file_namestringrequis

  • size_bytesintegerrequis

  • purposestringrequis

    Valeurs : model · ids

  • upload_urlstring (uri) | null

    Point d'entrée TUS ; nul une fois le dépôt clos.

  • upload_headersobject | null

    En-têtes à joindre aux requêtes TUS.

  • expires_atstring (date-time)requis

Job object

  • idstring (uuid)requis

  • typestringrequis

    Valeurs : conversion · ids_check · export

  • statusProcessingStatusrequis

  • percent_completenumber | null

    Nul quand le moteur n'a pas encore donné de progression.

  • eta_secondsnumber | null

  • targetobjectrequis

  • resultobject | null

    Export : URL signée et taille. Contrôle IDS terminé : le score en une ligne (le détail se lit dans les résultats IDS de la révision). Conversion : nul, lire la révision.

  • errorobject | null

  • created_atstring (date-time)requis

  • started_atstring (date-time) | null

  • completed_atstring (date-time) | null

NamingConvention object

  • idstring (uuid)requis

  • namestring | nullrequis

  • delimiterstringrequis

    Séparateurs des parties du nom ; chaque caractère en est un (_ par défaut).

  • part_countintegerrequis

  • project_idsstring (uuid)[]requis

    Projets auxquels la convention est rattachée.

  • created_atstring (date-time) | null

  • updated_atstring (date-time) | null

  • partsNamingConventionPart[]

    Présent à la lecture d'une convention, absent des listes.

NamingConventionPart object

  • positionintegerrequis

  • namestring | nullrequis

  • descriptionstring | null

  • typestring | nullrequis

    Valeurs : text · number · version · null

  • requiredbooleanrequis

  • min_valueinteger | null

  • max_valueinteger | null

  • max_lengthinteger | null

  • patternstring | null

    Expression régulière que la partie doit vérifier en entier.

  • allowed_valuesobject[]requis

    Valeurs permises ; vide quand la partie est libre.

NamingProblem object

  • codestringrequis

    Valeurs : no_rule · part_count · required · not_a_number · out_of_range · too_long · not_in_list · pattern

  • partstring | null

    Nom de la partie fautive.

  • expectedstring | null

    Ce que la règle attend, tel quel : nombre de parties, plage, liste, motif.

FileNameCheckRequest object

  • file_namesstring[]requis

FileNameResult object

  • file_namestringrequis

  • compliantbooleanrequis

  • problemsNamingProblem[]requis

  • valuesobjectrequis

    Valeur lue pour chaque partie, par nom de partie ; vide si le nom n'est pas conforme.

FileNameCheck object

  • naming_convention_idstring (uuid)requis

  • compliant_countintegerrequis

  • resultsFileNameResult[]requis

ModelNameCheck object

  • model_idstring (uuid)requis

  • naming_convention_idstring (uuid) | null

  • revision_idstring (uuid) | null

  • file_namestring | null

  • compliantboolean | null

    Nul quand rien n'a été contrôlé.

  • problemsNamingProblem[]requis

  • valuesobjectrequis

VisaGrid object

  • project_idstring (uuid)requis

  • customizedbooleanrequis

    Faux tant que le projet garde la grille par défaut.

  • criteriaobject[]requis

  • piecesobject[]requis

  • file_name_patternstring | null

  • max_file_size_mbnumber | null

  • updated_atstring (date-time) | null

  • updated_bystring | null

DocumentVersion object

  • idstring (uuid)requis

  • versionintegerrequis

  • file_namestring | null

    Nom du fichier déposé.

  • content_typestring | null

  • size_bytesinteger | null

  • created_bystring | null

  • created_atstring (date-time) | null

Document object

  • idstring (uuid)requis

  • namestring | null

  • descriptionstring | null

  • typestring | null

    Type du document dans l'App, par exemple DATA ou OTHER.

  • levelstringrequis

    Niveau où vit le document, qui décide d'où il est visible.

    Valeurs : organization · space · project

  • space_idstring (uuid) | null

    Espace du document quand level vaut space.

  • project_idstring (uuid) | null

    Projet du document quand level vaut project.

  • versioninteger | null

    Numéro de la version la plus récente ; nul sans version.

  • version_countintegerrequis

  • file_namestring | null

    Fichier de la version la plus récente.

  • content_typestring | null

  • size_bytesinteger | null

  • created_bystring | null

  • created_atstring (date-time) | null

  • modified_bystring | null

  • modified_atstring (date-time) | null

  • versionsDocumentVersion[]

    Versions, de la plus récente à la plus ancienne ; présent à la lecture d'un document.

DocumentDownload object

  • document_idstring (uuid)requis

  • versionintegerrequis

  • file_namestring | null

  • content_typestring | null

  • size_bytesinteger | null

  • download_urlstring (uri)requis

    Lien signé

  • download_expires_atstring (date-time)requis

KairnialProject object

  • project_keystringrequis

    Clé du projet dans Kairnial.

  • namestring | null

  • file_countintegerrequis

    Fichiers en dernière version.

  • size_bytesintegerrequis

KairnialExportCreate object

  • project_keystringrequis

    project_key rendu par GET /api/v1/kairnial-projects.

  • extensionsstring[]requis

    Extensions retenues, sans le point et sans tenir compte de la casse.

  • folder_idstring | null

    Dossier Kairnial ; ses sous-dossiers sont compris. Tout le projet par défaut.

KairnialExport object

  • idstring (uuid)requis

  • project_keystringrequis

  • project_namestring | null

  • extensionsstring[]requis

  • folder_idstring | null

  • statusstringrequis

    Valeurs : QUEUED · PROCESSING · COMPLETE · ERROR · EXPIRED

  • file_countintegerrequis

    Fichiers retenus au lancement.

  • done_countintegerrequis

    Fichiers traités

  • total_bytesintegerrequis

    Taille des fichiers retenus selon Kairnial.

  • partsobject[]requis

    Zips, présents quand l'export est COMPLETE.

  • skippedobject[]requis

    Fichiers que Kairnial n'a pas rendus, absents des zips.

  • errorstring | null

    Motif d'un export ERROR.

  • created_atstring (date-time)requis

  • started_atstring (date-time) | null

  • completed_atstring (date-time) | null

  • expires_atstring (date-time) | null

    Date d'effacement des zips.

VisaSheet object

  • idstring (uuid)requis

  • project_idstring (uuid)requis

  • model_idstring (uuid) | null

  • revision_idstring (uuid) | null

  • revision_versioninteger | null

  • diffusion_nointegerrequis

  • phasestring | null

    ESQ, APS, APD, PRO, EXE, DOE ou AUTRE.

  • statusstringrequis

    DRAFT ou SIGNED.

  • verdictstring | null

    ACCEPTED, ACCEPTED_WITH_OBS ou REFUSED ; posé à la signature.

  • scorenumber | null

    Taux de conformité pondéré ; nul si aucun critère n'est évalué.

  • created_bystring | null

  • created_atstring (date-time) | null

  • updated_atstring (date-time) | null

  • signed_bystring | null

  • signed_atstring (date-time) | null

  • global_commentstring | null

    Présent à la lecture d'une fiche.

  • itemsobject[]

    Critères évalués ; présent à la lecture d'une fiche.

  • piecesobject[]

    Pièces attendues trouvées ou non ; présent à la lecture d'une fiche.

  • historyobject[]

    Présent à la lecture d'une fiche.

  • previous_sheet_idstring (uuid) | null

    Fiche de la diffusion précédente de la même maquette.

IssueBoard object

  • idstring (uuid)requis

  • namestring | nullrequis

  • sourcestringrequis

    seveup : tableau d'un espace, modifiable. trimble, catenda : projet synchronisé, lecture seule.

    Valeurs : seveup · trimble · catenda

  • space_idstring (uuid) | null

    Espace racine du tableau (seveup seulement).

  • editablebooleanrequis

  • statusesobject[]requis

  • typesstring[]requis

  • prioritiesstring[]requis

IssueComment object

  • idstring (uuid)requis

  • textstringrequis

  • created_bystring | nullrequis

  • created_atstring (date-time) | nullrequis

Issue object

  • idstring (uuid)requis

  • board_idstring (uuid)requis

  • refstring | nullrequis

    Numéro affiché dans l'App, par exemple #12.

  • titlestring | nullrequis

  • descriptionstring | null

  • statusstring | null

    Nom du statut dans le tableau.

  • status_typestring | null

    Valeurs : open · closed · null

  • typestring | null

  • prioritystring | null

  • assigned_tostring | null

    Personne ou entreprise en charge (texte libre

  • due_datestring (date-time) | null

  • storeystring | null

    Niveau de la maquette.

  • modelsobject[]requis

    Maquettes (et révisions) sur lesquelles l'issue est posée.

  • comment_countintegerrequis

  • viewpoint_countintegerrequis

    Points de vue 3D enregistrés dans le viewer.

  • editablebooleanrequis

    Faux pour une issue d'un projet Trimble ou Catenda synchronisé.

  • created_bystring | null

  • created_atstring (date-time) | null

  • modified_bystring | null

  • modified_atstring (date-time) | null

  • commentsIssueComment[]

    Présent à la lecture d'une issue, absent des listes.

IssueCreate object

  • model_idstring (uuid)requis

  • revision_idstring (uuid) | null

    Révision de cette maquette ; la dernière si absent.

  • titlestringrequis

  • descriptionstring | null

  • typestring | null

    Nom d'un type du tableau ; Remarque si absent.

  • prioritystring | null

    Valeurs : Basse · Normale · Haute · Critique · null

  • assigned_tostring | null

  • due_datestring (date-time) | null

IssueUpdate object

  • titlestring

  • descriptionstring | null

  • statusstring

    Nom d'un statut du tableau.

  • typestring

    Nom d'un type du tableau.

  • prioritystring

    Valeurs : Basse · Normale · Haute · Critique

  • assigned_tostring | null

  • due_datestring (date-time) | null

IssueCommentCreate object

  • textstringrequis

WebhookEventType string

Valeurs : revision.processing.completed · revision.processing.failed · ids_check.completed · ids_check.failed · export.ready

Webhook object

  • idstring (uuid)requis

  • namestringrequis

  • urlstring (uri)requis

  • eventsWebhookEventType[]requis

  • activebooleanrequis

  • last_delivered_atstring (date-time) | null

  • last_statusinteger | null

  • created_atstring (date-time)requis

WebhookCreate object

  • namestringrequis

  • urlstring (uri)requis

    HTTPS uniquement, 2000 caractères au plus.

  • eventsWebhookEventType[]requis

WebhookDelivery object

  • idstring (uuid)requis

    Valeur de l'en-tête webhook-id.

  • eventstringrequis

  • statusstringrequis

    pending en file ou en attente d'un nouvel essai ; delivered reçu en 2xx ; failed refusé par le destinataire (4xx) ; abandoned essais épuisés ou abonnement supprimé ; refused URL non publique.

    Valeurs : pending · delivered · failed · abandoned · refused

  • attemptsintegerrequis

  • response_codeinteger | null

  • errorstring | null

  • created_atstring (date-time)requis

  • delivered_atstring (date-time) | null

  • next_attempt_atstring (date-time) | null

WebhookEvent object

  • typeWebhookEventTyperequis

  • timestampstring (date-time)requis

  • dataobjectrequis