Quality Campaigns

Modifier une campagne de mise en qualité

Changed on
patch/api/v2/quality-campaigns/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/auth, token URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/token)
    • API key in header x-refapp-token

Path parameters

idstring required

Request body

namestring

Nom donné à la campagne

filtersobject

Filtres de recherche d'applications définissant les cibles de la campagne (mêmes clés que la query de GET /applications)

messagestring nullable

Message incitatif inclus dans l'email de relance envoyé aux acteurs des applications ciblées

sponsorEmailsstring[]

Emails des sponsors (porteurs) de la campagne, destinataires des rapports de résultats

startDatestring date-time

Date de démarrage de la campagne : déclenche l'envoi automatique aux acteurs

endDatestring date-time nullable

Date de fin indicative de la campagne (affichage uniquement)

Response

Campagne mise à jour

idstring required
namestring required
filtersobject required

Filtres de recherche d'applications définissant les cibles

messagestring nullable
sponsorEmailsstring[] required

Emails des sponsors (porteurs) de la campagne

startDatestring date-time required
endDatestring date-time nullable
sentAtstring date-time nullable
createdAtstring date-time required
status'scheduled' | 'in_progress' | 'done' required

Statut librement modifiable par l'admin : « scheduled » (planifiée), « in_progress » (en cours), « done » (terminée). Avance automatiquement de « scheduled » à « in_progress » à l'envoi de la relance, mais reste corrigible manuellement dans n'importe quel sens.

targetCountnumber required

Nombre d'applications ciblées par la campagne. Avant l'envoi, calculé en direct depuis le filtre (la liste n'est figée qu'à l'envoi, pour capturer un IQ de départ fiable) ; après l'envoi, nombre d'applications réellement ciblées.

averageIqAtStartnumber nullable

IQ moyen des applications ciblées au moment de l'envoi

averageIqCurrentnumber nullable

IQ moyen actuel des applications ciblées

averageDeltanumber nullable

Évolution moyenne de l'IQ depuis l'envoi de la campagne

Changes

  • 87a5fdb7cecaRevision changes
    • warning

      added the new done enum value to the response property for the response status

    • warning

      added the new in_progress enum value to the response property for the response status

    • info

      removed the sent enum value from the response property for the response status

  • da3f180eda9fRevision changes
    • info

      the request property became nullable

    • info

      the request property became nullable