Skip to content

Process

Operações relacionadas à consulta de processos

Operations

Retorna o JSON cru de um processo ou formulário

Request

Retorna o JSON completo (sem transformações) de um processo ou formulário diretamente do MongoDB, a partir do ObjectId do documento.

Controle de acesso por nível de permissão da API Key:

  • tenant — retorna o documento somente se o city_id do documento corresponder ao município vinculado à API Key. Caso contrário, retorna 403.
  • support — acesso irrestrito, retorna qualquer documento independentemente do município.
Security
InternalAuth
Query
idstring^[a-fA-F0-9]{24}$required

ObjectId do documento (24 caracteres hexadecimais)

Example:id=507f1f77bcf86cd799439011
typestringrequired

Tipo do documento

Enum:"process""form"
Example:type=process
GET
/hub-api/document/json
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/document/json?id=507f1f77bcf86cd799439011&type=process' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

JSON do documento retornado com sucesso

Bodyapplication/json
property name*anyadditional property
Response
{
  "_id": "507f1f77bcf86cd799439011",
  "city_id": 123,
  "nP": "123-25-PRO-EXE"
}