Lister le dictionnaire de champs

curl --request GET \
  --url https://partner-api.marko.fr/v1/field-definitions \
  --header 'Authorization: Bearer <token>'

const url = 'https://partner-api.marko.fr/v1/field-definitions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/field-definitions', 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/field-definitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "items": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "field_key": "montant_pret",
      "table_name": "example",
      "column_name": "example",
      "label_fr": "Montant du prêt",
      "value_type": "texte",
      "importance": "essentielle",
      "is_required": false,
      "source_type": "document"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

{
  "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": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "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.

Query Parameters

limit

integer

default:20

Nombre maximal de résultats sur cette page; bornes et valeur par défaut ci-dessous.

Required range: 1 <= x <= 200

offset

integer

default:0

Nombre de résultats à ignorer avant cette page (commence à 0).

Required range: x >= 0

importance

string | null

Filter by importance (essentielle, utile, optionnelle)

verticale

string | null

Filter by verticale

page_onglet

string | null

Filter by page/onglet

source_type

string | null

Filter by source_type (document, calculation, hybrid, manual)

value_type

string | null

Filter by value_type

string | null

Search by label_fr or field_key

Response

Successful response

items

FieldDefinitionListResponse · object[]

required

Résultats de la page courante.

Show child attributes

total

integer

required

Nombre total de résultats correspondant aux filtres.

limit

integer

required

Limit used for this request

offset

integer

required

Nombre de résultats ignorés avant cette page.

page

integer

default:0

Numéro de la page courante, à partir de 1.

pages

integer

default:0

Nombre total de pages pour cette taille de page.

⌘I

Lister le dictionnaire de champs

curl --request GET \
  --url https://partner-api.marko.fr/v1/field-definitions \
  --header 'Authorization: Bearer <token>'

const url = 'https://partner-api.marko.fr/v1/field-definitions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/field-definitions', 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/field-definitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "items": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "field_key": "montant_pret",
      "table_name": "example",
      "column_name": "example",
      "label_fr": "Montant du prêt",
      "value_type": "texte",
      "importance": "essentielle",
      "is_required": false,
      "source_type": "document"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

{
  "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": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "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

Lister le dictionnaire de champs

Authorizations

Headers

Query Parameters

Response