Jobs

Valores de status do job: scheduled, running, completed, failed, cancelled.

Listar todos os jobs

Recupera todos os jobs de um projeto, incluindo os concluídos e os cancelados. Paginado.

Método

GET

URL

/public/:projectKey/jobs

Parâmetros de consulta

Nome	Tipo	Descrição
limit	integer	Tamanho da página, 1-200 (padrão: 50). Valores fora do intervalo voltam para 50.
page	integer	Número da página, começando em 1 (padrão: 1). Valores < 1 voltam para 1.

Cabeçalhos da requisição

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Exemplo de requisição

curl -X GET \
  '{BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/jobs?limit=50&page=1' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

Exemplo de resposta

{
  "data": [
    {
      "jobId": 3451,
      "description": "Delete user sessions of userId = shekar@example.com",
      "status": "scheduled",
      "projectId": 1,
      "action": "delete_user_data",
      "referenceId": "shekar@example.com",
      "createdAt": 1623912955277,
      "updatedAt": null,
      "startAt": 1623954600000,
      "errors": null
    },
    {
      "jobId": 3452,
      "description": "Delete user sessions of userId = mehdi@example.com",
      "status": "cancelled",
      "projectId": 1,
      "action": "delete_user_data",
      "referenceId": "mehdi@example.com",
      "createdAt": 1623912962910,
      "updatedAt": 1623913015276,
      "startAt": 1623954600000,
      "errors": null
    }
  ]
}

Obter detalhes do job

Retorna o status e os metadados do job.

Método

GET

URL

/public/:projectKey/jobs/:jobId

Parâmetros

Nome	Tipo	Descrição
jobId	integer	O ID do job (obrigatório)

Cabeçalhos da requisição

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Códigos de status

200: Resposta enviada como JSON no corpo
400: jobId inválido (não é um inteiro)
404: Job não encontrado

Exemplo de requisição

curl -X GET \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/jobs/3451 \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

Exemplo de resposta

{
  "data": {
    "jobId": 3451,
    "description": "Delete user sessions of userId = shekar@example.com",
    "status": "scheduled",
    "projectId": 1,
    "action": "delete_user_data",
    "referenceId": "shekar@example.com",
    "createdAt": 1623912955277,
    "updatedAt": null,
    "startAt": 1623954600000,
    "errors": null
  }
}

Cancelar job

Cancela um job que ainda não começou ou que ainda está em andamento.

Método

DELETE

URL

/public/:projectKey/jobs/:jobId

Parâmetros

Nome	Tipo	Descrição
jobId	integer	O ID do job (obrigatório)

Cabeçalhos da requisição

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Códigos de status

200: Job cancelado
400: O job não pode ser cancelado em seu estado atual, ou jobId inválido
404: Job não encontrado

Exemplo de requisição

curl -X DELETE \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/jobs/3452 \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

Exemplo de resposta

{
  "data": {
    "jobId": 3452,
    "description": "Delete user sessions of userId = mehdi@example.com",
    "status": "cancelled",
    "projectId": 1,
    "action": "delete_user_data",
    "referenceId": "mehdi@example.com",
    "createdAt": 1623912962910,
    "updatedAt": 1623913015276,
    "startAt": 1623954600000,
    "errors": null
  }
}