Reference · 6 operations

support

The contract does not describe this family.

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.

Demandes d'assistance

GET/api/v1/support/requests

Les demandes de l'appelant ; toutes celles de l'institution avec `support.read_all`.

Operation identifier supportListRequests

Authentication and permissions

The contract does not declare authentication per operation. General rule: a bearer token in the Authorization header. Permissions: the contract does not declare them per operation. Read the authentication rule

Query parameters

scope"mine" | "institution"optional
default: "mine"
limitintegeroptional
minimum: 1 · maximum: 100 · default: 25
offsetintegeroptional
minimum: 0 · maximum: 100000 · default: 0

Request body

No request body.

Responses

200Successful responseapplication/jsonarray<SupportRequestOut>
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X GET "$NEXCLARA_API_URL/api/v1/support/requests" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Response 200json

[
  {
    "app_version": "exemple",
    "category": "functional",
    "created_at": "2026-10-15T09:30:00Z",
    "description": "exemple",
    "id": "00000000-0000-4000-8000-000000000001",
    "impact": "blocking",
    "module": "admin",
    "pilot_step": null,
    "priority": "critical",
    "priority_reason": "enhancement_request",
    "public_note": null,
    "reference": "DEMO-0001",
    "requester_note": null,
    "row_version": 1,
    "status": "created",
    "summary": "exemple",
    "transmitted": false,
    "transmitted_at": null,
    "updated_at": "2026-10-15T09:30:00Z"
  }
]

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.

Creer une demande d'assistance

POST/api/v1/support/requests

Cree la demande ; la meme cle d'idempotence rend la meme demande (statut 200).

Operation identifier supportCreateRequest

Authentication and permissions

Request body

application/jsonSupportRequestInrequired

Body fields

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

Responses

200Deja creee.application/jsonSupportRequestOut
Fields of the 200 response
- app_versionstringrequired
- category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"required
- created_atstring (date-time)required
- descriptionstringrequired
- idstring (uuid)required
- impact"blocking" | "degraded" | "none"required
- module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"required
- pilot_stepstring | nullrequired
- priority"critical" | "high" | "normal" | "low"required
- priority_reason"enhancement_request" | "security_blocking" | "security_category" | "blocking_impact" | "degraded_impact" | "no_operational_impact" | "requalified_by_nexclara"required
- public_notestring | nullrequired
  Derniere note publique de NEXCLARA.
- referencestringrequired
- requester_notestring | nullrequired
- row_versionintegerrequired
- status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed"required
- summarystringrequired
- transmittedbooleanrequired
  Vrai si la DERNIERE revision a ete remise a CONTROL par l'agent.
- transmitted_atstring (date-time) | nullrequired
- updated_atstring (date-time)required
201Successful responseapplication/jsonSupportRequestOut
Fields of the 201 response
- app_versionstringrequired
- category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"required
- created_atstring (date-time)required
- descriptionstringrequired
- idstring (uuid)required
- impact"blocking" | "degraded" | "none"required
- module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"required
- pilot_stepstring | nullrequired
- priority"critical" | "high" | "normal" | "low"required
- priority_reason"enhancement_request" | "security_blocking" | "security_category" | "blocking_impact" | "degraded_impact" | "no_operational_impact" | "requalified_by_nexclara"required
- public_notestring | nullrequired
  Derniere note publique de NEXCLARA.
- referencestringrequired
- requester_notestring | nullrequired
- row_versionintegerrequired
- status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed"required
- summarystringrequired
- transmittedbooleanrequired
  Vrai si la DERNIERE revision a ete remise a CONTROL par l'agent.
- transmitted_atstring (date-time) | nullrequired
- updated_atstring (date-time)required
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X POST "$NEXCLARA_API_URL/api/v1/support/requests" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "functional",
  "description": "exemple-exemple-exemple",
  "idempotency_key": "00000000-0000-4000-8000-000000000001",
  "impact": "blocking",
  "module": "admin",
  "pilot_step": null,
  "summary": "exemple-exemple"
}'

Response 200json

{
  "app_version": "exemple",
  "category": "functional",
  "created_at": "2026-10-15T09:30:00Z",
  "description": "exemple",
  "id": "00000000-0000-4000-8000-000000000001",
  "impact": "blocking",
  "module": "admin",
  "pilot_step": null,
  "priority": "critical",
  "priority_reason": "enhancement_request",
  "public_note": null,
  "reference": "DEMO-0001",
  "requester_note": null,
  "row_version": 1,
  "status": "created",
  "summary": "exemple",
  "transmitted": false,
  "transmitted_at": null,
  "updated_at": "2026-10-15T09:30:00Z"
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.

Une demande et sa chronologie

GET/api/v1/support/requests/{request_id}

La demande, sa chronologie, et si l'appelant en est le demandeur.

Operation identifier supportGetRequest

Authentication and permissions

Path parameters

request_idstring (uuid)required

Request body

No request body.

Responses

200Successful responseapplication/jsonSupportRequestDetailOut
Fields of the 200 response
- eventsarray<SupportEventOut>required
- is_requesterbooleanrequired
- requestSupportRequestOutrequired
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X GET "$NEXCLARA_API_URL/api/v1/support/requests/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN"

Response 200json

{
  "events": [
    {
      "by_nexclara": false,
      "by_requester": false,
      "from_status": null,
      "id": "00000000-0000-4000-8000-000000000001",
      "kind": "created",
      "note": null,
      "occurred_at": "2026-10-15T09:30:00Z",
      "to_status": null
    }
  ],
  "is_requester": false,
  "request": {
    "app_version": "exemple",
    "category": "functional",
    "created_at": "2026-10-15T09:30:00Z",
    "description": "exemple",
    "id": "00000000-0000-4000-8000-000000000002",
    "impact": "blocking",
    "module": "admin",
    "pilot_step": null,
    "priority": "critical",
    "priority_reason": "enhancement_request",
    "public_note": null,
    "reference": "DEMO-0001",
    "requester_note": null,
    "row_version": 1,
    "status": "created",
    "summary": "exemple",
    "transmitted": false,
    "transmitted_at": null,
    "updated_at": "2026-10-15T09:30:00Z"
  }
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.

Confirmer la resolution

POST/api/v1/support/requests/{request_id}/confirmation

Le demandeur confirme la resolution : la demande est close.

Operation identifier supportConfirmResolution

Authentication and permissions

Path parameters

request_idstring (uuid)required

Request body

application/jsonSupportVersionInrequired

Body fields

row_versionintegerrequired
minimum: 1

Responses

200Successful responseapplication/jsonSupportRequestOut
Fields of the 200 response
- app_versionstringrequired
- category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"required
- created_atstring (date-time)required
- descriptionstringrequired
- idstring (uuid)required
- impact"blocking" | "degraded" | "none"required
- module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"required
- pilot_stepstring | nullrequired
- priority"critical" | "high" | "normal" | "low"required
- priority_reason"enhancement_request" | "security_blocking" | "security_category" | "blocking_impact" | "degraded_impact" | "no_operational_impact" | "requalified_by_nexclara"required
- public_notestring | nullrequired
  Derniere note publique de NEXCLARA.
- referencestringrequired
- requester_notestring | nullrequired
- row_versionintegerrequired
- status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed"required
- summarystringrequired
- transmittedbooleanrequired
  Vrai si la DERNIERE revision a ete remise a CONTROL par l'agent.
- transmitted_atstring (date-time) | nullrequired
- updated_atstring (date-time)required
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X POST "$NEXCLARA_API_URL/api/v1/support/requests/00000000-0000-4000-8000-000000000001/confirmation" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "row_version": 1
}'

Response 200json

{
  "app_version": "exemple",
  "category": "functional",
  "created_at": "2026-10-15T09:30:00Z",
  "description": "exemple",
  "id": "00000000-0000-4000-8000-000000000001",
  "impact": "blocking",
  "module": "admin",
  "pilot_step": null,
  "priority": "critical",
  "priority_reason": "enhancement_request",
  "public_note": null,
  "reference": "DEMO-0001",
  "requester_note": null,
  "row_version": 1,
  "status": "created",
  "summary": "exemple",
  "transmitted": false,
  "transmitted_at": null,
  "updated_at": "2026-10-15T09:30:00Z"
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.

Repondre a une demande d'information

POST/api/v1/support/requests/{request_id}/information

Le demandeur repond ; la demande revient en traitement chez NEXCLARA.

Operation identifier supportProvideInformation

Authentication and permissions

Path parameters

request_idstring (uuid)required

Request body

application/jsonSupportNoteInrequired

Body fields

notestringrequired
minLength: 10 · maxLength: 2000
row_versionintegerrequired
minimum: 1

Responses

200Successful responseapplication/jsonSupportRequestOut
Fields of the 200 response
- app_versionstringrequired
- category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"required
- created_atstring (date-time)required
- descriptionstringrequired
- idstring (uuid)required
- impact"blocking" | "degraded" | "none"required
- module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"required
- pilot_stepstring | nullrequired
- priority"critical" | "high" | "normal" | "low"required
- priority_reason"enhancement_request" | "security_blocking" | "security_category" | "blocking_impact" | "degraded_impact" | "no_operational_impact" | "requalified_by_nexclara"required
- public_notestring | nullrequired
  Derniere note publique de NEXCLARA.
- referencestringrequired
- requester_notestring | nullrequired
- row_versionintegerrequired
- status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed"required
- summarystringrequired
- transmittedbooleanrequired
  Vrai si la DERNIERE revision a ete remise a CONTROL par l'agent.
- transmitted_atstring (date-time) | nullrequired
- updated_atstring (date-time)required
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X POST "$NEXCLARA_API_URL/api/v1/support/requests/00000000-0000-4000-8000-000000000001/information" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Exemple synthetique",
  "row_version": 1
}'

Response 200json

{
  "app_version": "exemple",
  "category": "functional",
  "created_at": "2026-10-15T09:30:00Z",
  "description": "exemple",
  "id": "00000000-0000-4000-8000-000000000001",
  "impact": "blocking",
  "module": "admin",
  "pilot_step": null,
  "priority": "critical",
  "priority_reason": "enhancement_request",
  "public_note": null,
  "reference": "DEMO-0001",
  "requester_note": null,
  "row_version": 1,
  "status": "created",
  "summary": "exemple",
  "transmitted": false,
  "transmitted_at": null,
  "updated_at": "2026-10-15T09:30:00Z"
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.

Rouvrir une demande resolue

POST/api/v1/support/requests/{request_id}/reopening

Le demandeur rouvre, en disant pourquoi.

Operation identifier supportReopenRequest

Authentication and permissions

Path parameters

request_idstring (uuid)required

Request body

application/jsonSupportNoteInrequired

Body fields

notestringrequired
minLength: 10 · maxLength: 2000
row_versionintegerrequired
minimum: 1

Responses

200Successful responseapplication/jsonSupportRequestOut
Fields of the 200 response
- app_versionstringrequired
- category"functional" | "calibration" | "import" | "access" | "defect" | "security" | "compliance" | "pilot" | "report" | "enhancement"required
- created_atstring (date-time)required
- descriptionstringrequired
- idstring (uuid)required
- impact"blocking" | "degraded" | "none"required
- module"admin" | "desk" | "link" | "trust" | "policies" | "pilot" | "reports" | "platform"required
- pilot_stepstring | nullrequired
- priority"critical" | "high" | "normal" | "low"required
- priority_reason"enhancement_request" | "security_blocking" | "security_category" | "blocking_impact" | "degraded_impact" | "no_operational_impact" | "requalified_by_nexclara"required
- public_notestring | nullrequired
  Derniere note publique de NEXCLARA.
- referencestringrequired
- requester_notestring | nullrequired
- row_versionintegerrequired
- status"created" | "qualified" | "assigned" | "in_progress" | "awaiting_information" | "resolved" | "closed"required
- summarystringrequired
- transmittedbooleanrequired
  Vrai si la DERNIERE revision a ete remise a CONTROL par l'agent.
- transmitted_atstring (date-time) | nullrequired
- updated_atstring (date-time)required
422Validation errorapplication/jsonHTTPValidationError

Requestbash

# Bearer token if the operation requires one
curl -X POST "$NEXCLARA_API_URL/api/v1/support/requests/00000000-0000-4000-8000-000000000001/reopening" \
  -H "Authorization: Bearer $NEXCLARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "Exemple synthetique",
  "row_version": 1
}'

Response 200json

{
  "app_version": "exemple",
  "category": "functional",
  "created_at": "2026-10-15T09:30:00Z",
  "description": "exemple",
  "id": "00000000-0000-4000-8000-000000000001",
  "impact": "blocking",
  "module": "admin",
  "pilot_step": null,
  "priority": "critical",
  "priority_reason": "enhancement_request",
  "public_note": null,
  "reference": "DEMO-0001",
  "requester_note": null,
  "row_version": 1,
  "status": "created",
  "summary": "exemple",
  "transmitted": false,
  "transmitted_at": null,
  "updated_at": "2026-10-15T09:30:00Z"
}

Synthetic example generated from the contract and validated against its schema. Free “exemple” keys are illustrative.