Skip to main content
NEXCLARASearch

Search the documentation

MenuClose menu

Schemas: support

Schemas whose first using operation belongs to the support family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French without accents. They are reproduced as is so that the contract remains the source of truth.

SupportEventOut

Evenement de la chronologie.

Type : object

PropertyTypeRequiredDescriptionConstraints
by_nexclarabooleanyes
by_requesterbooleanyes
from_status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed" | nullyes
idstring (uuid)yes
kind"created" | "information_provided" | "resolution_confirmed" | "reopened" | "transmitted" | "status_received"yes
notestring | nullyes
occurred_atstring (date-time)yes
to_status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed" | nullyes

Used by : supportGetRequest

SupportNoteIn

Reponse du demandeur (information, reouverture).

Type : object

PropertyTypeRequiredDescriptionConstraints
notestringyesminLength: 10 ; maxLength: 2000
row_versionintegeryesminimum: 1

Used by : supportProvideInformation, supportReopenRequest

SupportRequestDetailOut

Une demande, sa chronologie, et ce que l'appelant peut y faire.

Type : object

PropertyTypeRequiredDescriptionConstraints
eventsarray<SupportEventOut>yes
is_requesterbooleanyes
requestSupportRequestOutyes

Used by : supportGetRequest

SupportRequestIn

Demande a creer. Ni pieces jointes, ni donnee personnelle (ADR-0071, decisions 5 et 6).

Type : object

PropertyTypeRequiredDescriptionConstraints
category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"yes
descriptionstringyesminLength: 20 ; maxLength: 4000
idempotency_keystring (uuid)yesTiree une fois par formulaire : la meme cle rend la meme demande.
impact"blocking" | "degraded" | "none"yes
module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"yes
pilot_stepstring | nullnoEtape du pilote (ADR-0070), facultative ; forme `[a-z][a-z0-9_.]{1,63}`.maxLength: 64
summarystringyesminLength: 8 ; maxLength: 120

Used by : supportCreateRequest

SupportRequestOut

Demande d'assistance, telle que l'institution la voit.

Type : object

PropertyTypeRequiredDescriptionConstraints
app_versionstringyes
category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"yes
created_atstring (date-time)yes
descriptionstringyes
idstring (uuid)yes
impact"blocking" | "degraded" | "none"yes
module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"yes
pilot_stepstring | nullyes
priority"critical" | "high" | "normal" | "low"yes
priority_reason"enhancement_request" | "security_blocking" | "security_category" | "blocking_impact" | "degraded_impact" | "no_operational_impact" | "requalified_by_nexclara"yes
public_notestring | nullyesDerniere note publique de NEXCLARA.
referencestringyes
requester_notestring | nullyes
row_versionintegeryes
status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed"yes
summarystringyes
transmittedbooleanyesVrai si la DERNIERE revision a ete remise a CONTROL par l'agent.
transmitted_atstring (date-time) | nullyes
updated_atstring (date-time)yes

Used by : supportConfirmResolution, supportCreateRequest, supportGetRequest, supportListRequests, supportProvideInformation, supportReopenRequest

SupportVersionIn

Ecriture sans autre donnee que la version lue.

Type : object

PropertyTypeRequiredDescriptionConstraints
row_versionintegeryesminimum: 1

Used by : supportConfirmResolution