Pular para o conteúdo principal

Métodos HTTP e schema

Métodos​

MétodoAção
GETRecupera um recurso ou uma lista de recursos
POSTCria um recurso
PUTAtualiza um recurso existente
DELETERemove um recurso

Formato dos dados​

O corpo das requisições e das respostas é JSON. Requisições com corpo devem enviar Content-Type: application/json.

Datas são retornadas no formato ISO 8601, sempre em UTC: YYYY-MM-DDTHH:MM:SSZ (ex.: 2026-10-13T14:30:00Z).

Recurso individual​

Um recurso é retornado como um objeto:

{
  "id": "NTox",
  "name": "Manutenção corretiva",
  "archived": false
}

Os identificadores (id) são textos opacos: use-os como recebidos, sem tentar interpretar o conteúdo.

Lista de recursos​

Listas são retornadas em items, com o total de registros que atendem aos filtros em totalCount:

{
  "items": [
    { "id": "NTox", "name": "Instalação", "archived": false },
    { "id": "NjAx", "name": "Reparo", "archived": false }
  ],
  "totalCount": 2
}

Veja como navegar pelas páginas em Paginação.