Skip to content

Cria um despacho

Request

Cria um novo despacho a partir de um formulário Formly.

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

  • tenant — o despacho é vinculado ao município da API Key; o campo cityId é ignorado.
  • support — o campo cityId é obrigatório e define o município ao qual o despacho pertence.
Security
InternalAuth
Bodyapplication/jsonrequired
formobjectrequired

Formulário Formly do despacho

namestring

Nome do despacho

Example:"Despacho de Aprovação"
cityIdnumber

ID do município. Obrigatório para API Keys do tipo support; ignorado para tenant.

Example:42
POST
/hub-api/blueprint-post
curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/blueprint-post \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Despacho de Aprovação",
    "form": {
      "formData": [
        {
          "fieldGroup": [
            {
              "fieldGroup": [
                {
                  "type": "next-ck",
                  "key": "justificativa",
                  "templateOptions": {
                    "label": "Justificativa",
                    "required": true,
                    "hideLabel": false,
                    "columns": "12",
                    "hiddenTemp": false,
                    "readonly": false,
                    "sensitiveField": false
                  },
                  "className": "col-12"
                },
                {
                  "type": "next-input",
                  "key": "numero_processo",
                  "templateOptions": {
                    "label": "Número do Processo",
                    "required": true,
                    "hideLabel": false,
                    "columns": "12",
                    "hiddenTemp": false,
                    "readonly": false,
                    "sensitiveField": false
                  },
                  "className": "col-12"
                },
                {
                  "type": "next-upload",
                  "key": "anexos",
                  "templateOptions": {
                    "label": "Anexos",
                    "required": false,
                    "hideLabel": false,
                    "columns": "12",
                    "extends": [
                      "PDF",
                      "PNG",
                      "JPG",
                      "JPEG"
                    ],
                    "compactView": false,
                    "hiddenTemp": false,
                    "readonly": false,
                    "sensitiveField": false
                  },
                  "className": "col-12"
                },
                {
                  "type": "radio",
                  "key": "aprovado",
                  "templateOptions": {
                    "label": "Aprovado?",
                    "required": true,
                    "hideLabel": false,
                    "columns": "12",
                    "hiddenTemp": false,
                    "readonly": false,
                    "sensitiveField": false,
                    "options": [
                      {
                        "label": "Sim",
                        "value": "true"
                      },
                      {
                        "label": "Não",
                        "value": "false"
                      }
                    ]
                  },
                  "className": "col-12"
                }
              ],
              "wrappers": [
                "card-post"
              ],
              "expressionProperties": {}
            }
          ]
        }
      ]
    }
  }'

Responses

Despacho criado com sucesso

Bodyapplication/json
idstring, (uuid)
Example:"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
cityIdnumber
Example:42
formobject
namestring
Example:"Despacho de Aprovação"
disabledboolean
Example:false
allowedUserTypesArray of strings
Example:
[
  "Aprovador"
]
statusListArray of strings
Example:
[
  "Em análise"
]
deadlineFormatstring or null
Example:"days"
deadlineValuenumber or null
Example:5
createdAtstring, (date-time)
Example:"2026-01-15T10:30:00.000Z"
deletedAtstring or null, (date-time)
Example:"2026-02-01T00:00:00.000Z"
deletedboolean
Example:false
Response
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "cityId": 42,
  "name": "Despacho de Aprovação",
  "form": {
    "formData": [ … ]
  },
  "disabled": false,
  "allowedUserTypes": [],
  "statusList": [],
  "deadlineFormat": null,
  "deadlineValue": null,
  "createdAt": "2024-03-15T14:22:10.000Z",
  "deletedAt": null,
  "deleted": false
}