Schemas

Problem object

• typestring (uri)required

• titlestringrequired

• statusintegerrequired

• codestringrequired

  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.

  Values : 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

• detailstring

• instancestring

• errorsobject[]

  Détail par champ, pour VALIDATION.

Page object

• dataany[]required

• next_cursorstring | nullrequired

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

• has_morebooleanrequired

ProcessingStatus string

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

Project object

• idstring (uuid)required

• namestringrequired

• 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)required

• updated_atstring (date-time)required

Model object

• idstring (uuid)required

• namestringrequired

• formatstringrequired

  Values : IFC · REVIT

• revision_countintegerrequired

• latest_revision_idstring (uuid) | null

• created_atstring (date-time)required

• updated_atstring (date-time)required

ModelCreate object

• namestringrequired

• upload_idstring (uuid)required

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

StepStatus object

• statusProcessingStatusrequired

• percent_completenumber | null

• eta_secondsnumber | null

• error_messagestring | null

Revision object

• idstring (uuid)required

• model_idstring (uuid)required

• versionintegerrequired

• milestonestring | null

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

• file_namestring | null

• size_bytesinteger | null

• ifc_schemastring | null

  Ex. IFC2X3, IFC4, IFC4X3_ADD2.

• authoring_softwarestring | null

• statusProcessingStatusrequired

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

• processingobjectrequired

• 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)required

RevisionCreate object

• upload_idstring (uuid)required

• milestonestring

IdsSpecificationResult object

• indexintegerrequired

• namestringrequired

• descriptionstring | null

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

• statusstringrequired

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

  Values : PASS · PARTIAL · FAIL · NA · MISMATCH

• applicablebooleanrequired

  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)required

• requirement_set_revision_idstring (uuid)required

• statusProcessingStatusrequired

• score_percentnumber | null

• specification_countinteger | null

• specification_count_applicableinteger | null

• specification_count_failedinteger | null

• completed_atstring (date-time) | null

• specificationsIdsSpecificationResult[]

  Vide tant que status n'est pas COMPLETE.

IdsFacet object

• typestringrequired

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

• cardinalitystring

  Exigences seulement.

  Values : 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

• requirementintegerrequired

  Position dans requirements.

• statestringrequired

  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…).

  Values : 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

  Values : object · type · null

IdsInvalidObject object

• object_idintegerrequired

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

• global_idstring | null

• namestring | null

• ifc_classstring | null

• checksIdsObjectCheck[]required

IdsSpecificationFailure object

• indexintegerrequired

• namestringrequired

• descriptionstring | null

• instructionsstring | null

• identifierstring | null

• statusstringrequired

  Values : PASS · PARTIAL · FAIL · NA · MISMATCH

• applicablebooleanrequired

• cardinalitystring | null

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

  Values : required · optional · prohibited · null

• failurestringrequired

  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.

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

• score_percentnumber | null

• entity_count_applicableinteger

• entity_count_invalidinteger

• applicabilityIdsFacet[]required

• requirementsIdsFacet[]required

• invalid_objectsIdsInvalidObject[]required

• 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)required

• requirement_set_idstring (uuid)required

• requirement_set_revision_idstring (uuid)required

• statusProcessingStatusrequired

• completed_atstring (date-time) | null

• definitions_availableboolean

• details_availableboolean

• object_data_availableboolean

• dataIdsSpecificationFailure[]required

• next_cursorstring | null

• has_morebooleanrequired

IdsFailuresBcf object

• revision_idstring (uuid)required

• requirement_set_idstring (uuid)required

• requirement_set_revision_idstring (uuid)required

• statusProcessingStatusrequired

• completed_atstring (date-time) | null

• details_availablebooleanrequired

• topic_countintegerrequired

• file_namestring | null

• size_bytesinteger | null

• download_urlstring (uri) | null

• download_expires_atstring (date-time) | null

ObjectRow object

• object_idintegerrequired

• global_idstring | null

• namestring | null

• ifc_classstring | null

• statestring | null

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

  Values : MISSING · EMPTY · PRESENT · null

• valuestring | null

• value_sourcestring | null

  Values : object · type · null

ObjectPage object

• revision_idstring (uuid)required

• dataObjectRow[]required

• next_cursorstring | nullrequired

• has_morebooleanrequired

• totalinteger | null

IdsSummary object

• project_idstring (uuid)required

• model_countintegerrequired

• 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)required

RequirementSet object

• idstring (uuid)required

• namestringrequired

• formatstringrequired

  Values : IDS · SEVEUP

• scopestringrequired

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

  Values : ORGANIZATION · SPACE · PROJECT

• scope_idstring (uuid) | null

• latest_revision_idstring (uuid) | null

• specification_countinteger | null

• created_atstring (date-time)required

• updated_atstring (date-time)required

RequirementSetCreate object

• namestringrequired

• upload_idstring (uuid)required

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

• project_idstring (uuid)

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

IdsCheckCreate object

• revision_idstring (uuid)required

• requirement_set_idstring (uuid)required

ExportCreate object

• tablesstring[]

  Tables à inclure ; toutes par défaut.

• formatstring

  Format des fichiers de l'archive.

  Values : csv · json

UploadCreate object

• file_namestringrequired

• size_bytesintegerrequired

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

• purposestringrequired

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

  Values : model · ids

Upload object

• idstring (uuid)required

• statusstringrequired

  Values : PENDING · COMPLETE

• file_namestringrequired

• size_bytesintegerrequired

• purposestringrequired

  Values : 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)required

Job object

• idstring (uuid)required

• typestringrequired

  Values : conversion · ids_check · export

• statusProcessingStatusrequired

• percent_completenumber | null

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

• eta_secondsnumber | null

• targetobjectrequired

• 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)required

• started_atstring (date-time) | null

• completed_atstring (date-time) | null

WebhookEventType string

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

Webhook object

• idstring (uuid)required

• namestringrequired

• urlstring (uri)required

• eventsWebhookEventType[]required

• activebooleanrequired

• last_delivered_atstring (date-time) | null

• last_statusinteger | null

• created_atstring (date-time)required

WebhookCreate object

• namestringrequired

• urlstring (uri)required

  HTTPS uniquement, 2000 caractères au plus.

• eventsWebhookEventType[]required

WebhookDelivery object

• idstring (uuid)required

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

• eventstringrequired

• statusstringrequired

  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.

  Values : pending · delivered · failed · abandoned · refused

• attemptsintegerrequired

• response_codeinteger | null

• errorstring | null

• created_atstring (date-time)required

• delivered_atstring (date-time) | null

• next_attempt_atstring (date-time) | null

WebhookEvent object

• typeWebhookEventTyperequired

• timestampstring (date-time)required

• dataobjectrequired