Skip to main content
Accepter une recommandation

Authorizations

Authorization
string
header
required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID
string

Partner-generated correlation identifier echoed in logs and error payloads.

Path Parameters

recommendation_id
string<uuid>
required

Paramètre recommendation_id pour cette route; type, format et contraintes ci-dessous.

Body

application/json
note
string | null

Commentaire associé à la décision sur la recommandation.

Maximum string length: 1000
reason
string | null

Motif donné pour la décision sur la recommandation.

Maximum string length: 255

Response

Successful response

id
string
required

UUID après matérialisation; identifiant preview-* dans une prévisualisation.

scope_type
string
required

Périmètre auquel la recommandation ou l'objet se rapporte.

scope_id
string<uuid> | null
required

Identifiant de la ressource du périmètre; il peut être absent pour le périmètre entité.

bundle_key
string
required

Clé du groupe de recommandations à matérialiser.

bundle_label
string
required

Libellé du groupe de recommandations.

workflow_key
string
required

Clé du workflow proposé dans le groupe de recommandations.

workflow_label
string
required

Nom du workflow proposé par la recommandation.

workflow_type
string
required

Type de traitement du workflow proposé.

title
string
required

Titre affiché pour l'événement ou le problème.

description
string
required

Description libre de la ressource.

expected_impact
string
required

Effet métier attendu de la recommandation.

score
number
required

Score de classement de la recommandation.

confidence
number
required

Confiance associée à la recommandation, distincte de son score de classement.

priority
enum<string>
required

Priorité de l'élément; les valeurs acceptées figurent dans le schéma.

Available options:
critical,
recommended,
optional
priority_label
string
required

Libellé de la priorité de la recommandation.

reason_codes
string[]
required

Codes des motifs ayant conduit à cette recommandation.

evidence
object[]
required

Données utilisées pour établir la recommandation; ne constituent pas à elles seules une autorisation d'écriture.

prefill
object
required

Objet JSON métier; les clés dépendent de la source ou du preset.

status
string
required

État de la recommandation: proposed, accepted, dismissed, snoozed ou created. created indique qu'un workflow a été créé depuis cette recommandation.

feedback
object
required

Objet JSON métier; les clés dépendent de la source ou du preset.

impact_metrics
object
required

Objet JSON métier; les clés dépendent de la source ou du preset.

accepted_at
string<date-time> | null

Date d'acceptation de la demande ou de la recommandation.

dismissed_at
string<date-time> | null

Date à laquelle la recommandation a été classée non pertinente.

snoozed_until
string<date-time> | null

Date jusqu'à laquelle l'alerte ou la recommandation est reportée.

created_workflow_key
string | null

Clé du workflow créé depuis la recommandation, si cette création a eu lieu.

workflow_created_at
string<date-time> | null

Date de création du workflow issu de cette recommandation.

note
string | null

Commentaire associé à la décision sur la recommandation.