iGRPIGRP 3.0Documentation

Recorrências

Envios periódicos e as suas execuções.

Listar recorrências

GET
/api/v1/recurrences

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
[index: integer]?
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences'
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "cron": "string",    "intervalSeconds": 0,    "startAt": "2019-08-24T14:15:22Z",    "endAt": "2019-08-24T14:15:22Z",    "status": "ACTIVE",    "createdAt": "2019-08-24T14:15:22Z"  }]

Criar recorrência

POST
/api/v1/recurrences

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Corpo do pedido

application/json
  1. body
cron?string
intervalSeconds?integer
Formatoint64
startAt?string
Formatodate-time
endAt?string
Formatodate-time
notification*
applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
cron?string
intervalSeconds?integer
Formatoint64
startAt?string
Formatodate-time
endAt?string
Formatodate-time
status?string
Valor em"ACTIVE""PAUSED""TERMINATED"
createdAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences' \  -H 'Content-Type: application/json' \  -d '{  "notification": {    "channelStrategy": "SPECIFIC"  }}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "cron": "string",  "intervalSeconds": 0,  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "status": "ACTIVE",  "createdAt": "2019-08-24T14:15:22Z"}

Obter recorrência

GET
/api/v1/recurrences/{id}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
cron?string
intervalSeconds?integer
Formatoint64
startAt?string
Formatodate-time
endAt?string
Formatodate-time
status?string
Valor em"ACTIVE""PAUSED""TERMINATED"
createdAt?string
Formatodate-time
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "cron": "string",  "intervalSeconds": 0,  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "status": "ACTIVE",  "createdAt": "2019-08-24T14:15:22Z"}

Terminar recorrência

DELETE
/api/v1/recurrences/{id}

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
cron?string
intervalSeconds?integer
Formatoint64
startAt?string
Formatodate-time
endAt?string
Formatodate-time
status?string
Valor em"ACTIVE""PAUSED""TERMINATED"
createdAt?string
Formatodate-time
curl -X DELETE 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "cron": "string",  "intervalSeconds": 0,  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "status": "ACTIVE",  "createdAt": "2019-08-24T14:15:22Z"}

Pausar recorrência

POST
/api/v1/recurrences/{id}/pause

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
cron?string
intervalSeconds?integer
Formatoint64
startAt?string
Formatodate-time
endAt?string
Formatodate-time
status?string
Valor em"ACTIVE""PAUSED""TERMINATED"
createdAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "cron": "string",  "intervalSeconds": 0,  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "status": "ACTIVE",  "createdAt": "2019-08-24T14:15:22Z"}

Retomar recorrência

POST
/api/v1/recurrences/{id}/resume

Permissão: igrp.notification.admin.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string

Corpo da resposta

OK

*/*
  1. response
id?string
Formatouuid
cron?string
intervalSeconds?integer
Formatoint64
startAt?string
Formatodate-time
endAt?string
Formatodate-time
status?string
Valor em"ACTIVE""PAUSED""TERMINATED"
createdAt?string
Formatodate-time
curl -X POST 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences/497f6eca-6276-4993-bfeb-53cbbbba6f08/resume'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "cron": "string",  "intervalSeconds": 0,  "startAt": "2019-08-24T14:15:22Z",  "endAt": "2019-08-24T14:15:22Z",  "status": "ACTIVE",  "createdAt": "2019-08-24T14:15:22Z"}

Execuções da recorrência

GET
/api/v1/recurrences/{id}/executions

Permissão: igrp.notification.read.

Autorização

bearer-jwt
headerAutorizaçãoBearer <token>

Token do Access Management. Os envios são M2M (client_credentials); a inbox usa o token do utilizador.

Parâmetros de caminho

id*string
Formatouuid

Parâmetros de query

applicationCode?string
pageable*

Corpo da resposta

OK

*/*
  1. response
content?array<>
page?integer
Formatoint32
size?integer
Formatoint32
totalElements?integer
Formatoint64
totalPages?integer
Formatoint32
curl -X GET 'http://localhost:2575/gateway-api/igrp-notification-service/api/v1/recurrences/497f6eca-6276-4993-bfeb-53cbbbba6f08/executions?page=0&size=1&sort=string'
{  "content": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "businessKey": "string",      "category": "string",      "priority": "string",      "channelStrategy": "string",      "createdAt": "2019-08-24T14:15:22Z",      "deliveryStats": {        "total": 0,        "pending": 0,        "queued": 0,        "sending": 0,        "sent": 0,        "delivered": 0,        "read": 0,        "failed": 0,        "cancelled": 0,        "expired": 0      }    }  ],  "page": 0,  "size": 0,  "totalElements": 0,  "totalPages": 0}
How is this guide?

Última atualização: