Obter status de job
curl --request GET \
--url https://services.pref.rio/go/api/v1/jobs/{jobId}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://services.pref.rio/go/api/v1/jobs/{jobId}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://services.pref.rio/go/api/v1/jobs/{jobId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://services.pref.rio/go/api/v1/jobs/{jobId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.pref.rio/go/api/v1/jobs/{jobId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.pref.rio/go/api/v1/jobs/{jobId}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.pref.rio/go/api/v1/jobs/{jobId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}jobs
Obter status de job
Retorna o status e progresso de um job em execução ou concluído
GET
/
api
/
v1
/
jobs
/
{jobId}
/
status
Obter status de job
curl --request GET \
--url https://services.pref.rio/go/api/v1/jobs/{jobId}/status \
--header 'Authorization: Bearer <token>'import requests
url = "https://services.pref.rio/go/api/v1/jobs/{jobId}/status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://services.pref.rio/go/api/v1/jobs/{jobId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://services.pref.rio/go/api/v1/jobs/{jobId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://services.pref.rio/go/api/v1/jobs/{jobId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://services.pref.rio/go/api/v1/jobs/{jobId}/status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://services.pref.rio/go/api/v1/jobs/{jobId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID do job (UUID)
Response
OK
Data/hora de conclusão
Data/hora de criação
Quantidade de registros com erro
Example:
2
Lista de erros detalhados por linha
ID único do job
Metadata adicional (curso_id, file_name, etc)
Progresso em porcentagem (0-100)
Example:
100
Resultado final do processamento
Status: pending, processing, completed, failed
Example:
"completed"
Quantidade de registros processados com sucesso
Example:
8
Total de registros a processar
Example:
10
Tipo de job (enrollment_import, etc)
Example:
"enrollment_import"
Data/hora da última atualização
