API ReferenceDocumentation APIToken PortailNotifications

Rechercher des notifications

Afficher en Markdown
Recherche dans toutes les notifications. <Note title="Rôle requis"> Aucun. Autorisés : le propriétaire. </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel
La ou les valeurs de filtre du champ id.
items.tenantIdstringOptionnel
La ou les valeurs de filtre du champ tenantId.
items.userIdstringOptionnel
La ou les valeurs de filtre du champ userId.
items.emailstringOptionnel
La ou les valeurs de filtre du champ email.
items.creatorstringOptionnel
La ou les valeurs de filtre du champ creator.
items.workflowIdstringOptionnel
La ou les valeurs de filtre du champ workflowId.
items.stepIdstringOptionnel
La ou les valeurs de filtre du champ stepId.
items.eventTypestringOptionnel
La ou les valeurs de filtre du champ eventType.
items.isUnreadstringOptionnel
La ou les valeurs de filtre du champ isUnread.
items.jobOperationstringOptionnel
La ou les valeurs de filtre du champ jobOperation.
items.jobErrorCodestringOptionnel
La ou les valeurs de filtre du champ jobErrorCode.
items.createdstringOptionnel
La ou les valeurs de filtre du champ created.
items.updatedstringOptionnel
La ou les valeurs de filtre du champ updated.
items.sendingStatestringOptionnel
La ou les valeurs de filtre du champ sendingState.
sortBystringOptionnel

Le champ utilisé pour trier le résultat de la recherche.

sortOrderenumOptionnel

L’ordre de tri du résultat de la recherche.

Valeurs autorisées:
itemsPerPageintegerOptionnel1-50Par défaut 50

Le nombre d’éléments par page à renvoyer.

pageIndexintegerOptionnel>=0Par défaut 0

L’index de la page à renvoyer.

Réponse

Une page d’entités Notification.

pageIndexintegerOptionnel
L'index de la page.
itemsPerPageintegerOptionnel

Le nombre d’éléments par page.

totalItemsintegerOptionnel

Le nombre total d’éléments, toutes pages comprises.

itemslist of objectsOptionnel

Erreurs

400
Bad Request Error
403
Forbidden Error