Skip to main content
GET
/
api
/
v1
/
jobs
/
{jobId}
/
status
Obter status de job
curl --request GET \
  --url https://services.pref.rio/go/v1/api/v1/jobs/{jobId}/status \
  --header 'Authorization: Bearer <token>'
{
  "completed_at": "<string>",
  "created_at": "<string>",
  "error_count": 2,
  "errors": [
    {}
  ],
  "id": "<string>",
  "metadata": {},
  "progress": 100,
  "result": {},
  "status": "completed",
  "success_count": 8,
  "total_records": 10,
  "type": "enrollment_import",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
jobId
string
required

ID do job (UUID)

Response

OK

​
completed_at
string

Data/hora de conclusão

​
created_at
string

Data/hora de criação

​
error_count
integer

Quantidade de registros com erro

Example:

2

​
errors
object[]

Lista de erros detalhados por linha

​
id
string

ID único do job

​
metadata
object

Metadata adicional (curso_id, file_name, etc)

​
progress
integer

Progresso em porcentagem (0-100)

Example:

100

​
result
object

Resultado final do processamento

​
status
enum<string>

Status: pending, processing, completed, failed

Available options:
pending,
processing,
completed,
failed
Example:

"completed"

​
success_count
integer

Quantidade de registros processados com sucesso

Example:

8

​
total_records
integer

Total de registros a processar

Example:

10

​
type
enum<string>

Tipo de job (enrollment_import, etc)

Available options:
enrollment_import
Example:

"enrollment_import"

​
updated_at
string

Data/hora da última atualização