Préparer une recommandation pour décision

curl --request POST \
  --url https://partner-api.marko.fr/v1/workflows/recommendations/materialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "scope_type": "entity",
  "scope_id": null,
  "bundle_key": "reporting",
  "workflow_key": "reporting_sponsor_escalation"
}
'

import requests

url = "https://partner-api.marko.fr/v1/workflows/recommendations/materialize"

payload = {
    "scope_type": "entity",
    "scope_id": None,
    "bundle_key": "reporting",
    "workflow_key": "reporting_sponsor_escalation"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/workflows/recommendations/materialize';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    scope_type: 'entity',
    scope_id: null,
    bundle_key: 'reporting',
    workflow_key: 'reporting_sponsor_escalation'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    scope_type: 'entity',
    scope_id: null,
    bundle_key: 'reporting',
    workflow_key: 'reporting_sponsor_escalation'
  })
};

fetch('https://partner-api.marko.fr/v1/workflows/recommendations/materialize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/workflows/recommendations/materialize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scope_type' => 'entity',
    'scope_id' => null,
    'bundle_key' => 'reporting',
    'workflow_key' => 'reporting_sponsor_escalation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "scope_type": "entity",
  "scope_id": null,
  "bundle_key": "example",
  "bundle_label": "example",
  "workflow_key": "example",
  "workflow_label": "example",
  "workflow_type": "example",
  "title": "example",
  "description": "example",
  "expected_impact": "example",
  "score": 0,
  "confidence": 0,
  "priority": "critical",
  "priority_label": "example",
  "reason_codes": [],
  "evidence": [],
  "prefill": {},
  "status": "proposed",
  "feedback": {},
  "impact_metrics": {}
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Idempotency-Key must contain at most 255 visible ASCII characters without spaces.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key payload, external reference, target, or source conflicts with an existing write.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Precondition Required",
  "status": 428,
  "detail": "The Idempotency-Key header is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

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.

Idempotency-Key

string

required

Required for every write, including environments where replay deduplication is disabled. Reuse the same value when retrying the same logical write and use a new value for a different write.

Maximum string length: 255

Pattern: ^[!-~]+$

Body

application/json

bundle_key

string

required

Clé du groupe de recommandations à matérialiser.

Required string length: 1 - 50

workflow_key

string

required

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

Required string length: 1 - 100

scope_type

string

default:entity

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

Maximum string length: 20

scope_id

string<uuid> | null

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

Response

Successful response

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.

Préparer une recommandation pour décision

curl --request POST \
  --url https://partner-api.marko.fr/v1/workflows/recommendations/materialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "scope_type": "entity",
  "scope_id": null,
  "bundle_key": "reporting",
  "workflow_key": "reporting_sponsor_escalation"
}
'

import requests

url = "https://partner-api.marko.fr/v1/workflows/recommendations/materialize"

payload = {
    "scope_type": "entity",
    "scope_id": None,
    "bundle_key": "reporting",
    "workflow_key": "reporting_sponsor_escalation"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/workflows/recommendations/materialize';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    scope_type: 'entity',
    scope_id: null,
    bundle_key: 'reporting',
    workflow_key: 'reporting_sponsor_escalation'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    scope_type: 'entity',
    scope_id: null,
    bundle_key: 'reporting',
    workflow_key: 'reporting_sponsor_escalation'
  })
};

fetch('https://partner-api.marko.fr/v1/workflows/recommendations/materialize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/workflows/recommendations/materialize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scope_type' => 'entity',
    'scope_id' => null,
    'bundle_key' => 'reporting',
    'workflow_key' => 'reporting_sponsor_escalation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "scope_type": "entity",
  "scope_id": null,
  "bundle_key": "example",
  "bundle_label": "example",
  "workflow_key": "example",
  "workflow_label": "example",
  "workflow_type": "example",
  "title": "example",
  "description": "example",
  "expected_impact": "example",
  "score": 0,
  "confidence": 0,
  "priority": "critical",
  "priority_label": "example",
  "reason_codes": [],
  "evidence": [],
  "prefill": {},
  "status": "proposed",
  "feedback": {},
  "impact_metrics": {}
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Idempotency-Key must contain at most 255 visible ASCII characters without spaces.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "detail": "The idempotency key payload, external reference, target, or source conflicts with an existing write.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Precondition Required",
  "status": 428,
  "detail": "The Idempotency-Key header is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Préparer une recommandation pour décision

Authorizations

Headers

Body

Response