Créer une règle de diffusion

Crée une règle de diffusion appliquée à un ou plusieurs de vos diffuseurs.

Crée une règle de diffusion pour un ou plusieurs de vos partenaires diffuseurs. Une fois la règle créée, seules vos missions qui la satisfont (ainsi que toutes les autres règles déjà configurées pour ce diffuseur) lui sont diffusées. Le fonctionnement général et la liste complète des champs et opérateurs sont décrits dans Comprendre les règles de diffusion.

Vous pouvez récupérer la liste de vos diffuseurs via Récupérer la liste des partenaires diffuseurs.

Corps de la requête

Champ	Obligatoire	Description
publisherIds	oui	Identifiants des diffuseurs auxquels appliquer la règle. Seuls les diffuseurs effectivement associés à votre compte sont pris en compte ; si aucun identifiant ne correspond, l'API renvoie une erreur 403.
field	oui	Champ de la mission évalué par la règle : type, publisherOrganizationId, publisherOrganization.clientId ou publisherOrganization.parentOrganizations.
operator	oui	Opérateur de comparaison : is, is_not, contains, does_not_contain, starts_with, is_greater_than, is_less_than, exists, does_not_exist.
value	oui	Valeur comparée au champ de la mission (ignorée pour exists et does_not_exist, mais à fournir tout de même).
fieldType	non	Type de la valeur évaluée (string par défaut).

Une règle est créée par diffuseur : la réponse contient autant d'entrées que de diffuseurs concernés, chacune avec son propre id (à utiliser pour la suppression).

L'opération est idempotente : si une règle identique (même field, value, operator et fieldType) existe déjà pour un diffuseur, la règle existante est retournée plutôt que dupliquée. En revanche, si une règle existe déjà pour le même field et la même value mais avec un opérateur différent, l'API renvoie une erreur 409.

Exemple — exclure les missions du réseau « Marine nationale » chez deux diffuseurs :

{
  "publisherIds": ["5f5931496c7ea514150a818f", "60a1b2c3d4e5f6789abc0001"],
  "field": "publisherOrganization.parentOrganizations",
  "operator": "does_not_contain",
  "value": "Marine nationale"
}

Créer une règle de diffusion

post

https://api.api-engagement.beta.gouv.frhttps://api.bac-a-sable.api-engagement.beta.gouv.frhttp://localhost:3002

/v0/diffusion-rule

Crée une règle de diffusion appliquée à un ou plusieurs de vos partenaires diffuseurs. Seuls les diffuseurs effectivement associés à votre compte sont pris en compte ; les autres identifiants fournis sont ignorés.

Une mission n'est diffusée vers un diffuseur que si elle satisfait l'ensemble des règles configurées pour ce diffuseur.

L'opération est idempotente : si une règle identique (même field, value, operator et fieldType) existe déjà pour un diffuseur, la règle existante est retournée plutôt que dupliquée. Si une règle existe pour le même field et value mais avec un opérateur différent, l'API renvoie une erreur 409 plutôt que de masquer silencieusement la demande.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Body

application/json

publisherIdsstring[] · min: 1Required

Identifiants des partenaires diffuseurs auxquels appliquer la règle

Example: ["5f5931496c7ea514150a818f","60a1b2c3d4e5f6789abc0001"]

fieldstringRequired

Champ de la mission évalué par la règle. Valeurs possibles : type, publisherOrganizationId, publisherOrganization.clientId, publisherOrganization.parentOrganizations.

Example: type

fieldTypestring · nullableOptional

Type de la valeur évaluée (par défaut string)

Example: string

operatorstringRequired

Opérateur de comparaison. Valeurs possibles : is, is_not, contains, does_not_contain, starts_with, is_greater_than, is_less_than, exists, does_not_exist.

Example: is_not

valuestringRequired

Valeur comparée au champ de la mission

Example: benevolat

Responses

201

Règle(s) créée(s)

application/json

okbooleanOptionalExample: true

totalintegerOptional

Nombre de règles créées (une par diffuseur)

Example: 2

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

403

Accès refusé

application/json

409

Conflit — la ressource existe déjà

application/json

post/v0/diffusion-rule

HTTPcURLJavaScriptPython

POST /v0/diffusion-rule HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "publisherIds": [
    "5f5931496c7ea514150a818f",
    "60a1b2c3d4e5f6789abc0001"
  ],
  "field": "type",
  "fieldType": "string",
  "operator": "is_not",
  "value": "benevolat"
}

{
  "ok": true,
  "total": 2,
  "data": [
    {
      "publisherId": "5f5931496c7ea514150a818f",
      "id": "9b1c2d3e-4f56-7890-abcd-ef0123456789",
      "field": "type",
      "fieldType": "string",
      "operator": "is_not",
      "value": "benevolat"
    }
  ]
}