v1

latestOpenAPI 3.1.02026-08-041420513.7 KB

Listar modelos de processos

Permite obter uma lista paginada de até 100 templates de processos vinculados ao escritório, com suporte a OData.

get/v1/accountingfirms/{accountingFirmId}/processtemplate

Path parameters

accountingFirmIdstring required

Id do escritório.

Query parameters

$filterstring

Filtra os resultados com base em critérios específicos. Exemplo: filter=Name eq 'Usuário X'.

$skipstring

Define o número de resultados a serem ignorados. Exemplo: skip=10.

$topstring

Limita o número de resultados retornados. Exemplo: top=5.

$orderbystring

Ordena os resultados. Exemplo: orderby=Name asc.

Headers

X-API-Keystring

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

X-User-Idstring

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Response

200

Example response

{
  "items": [
    {
      "id": "id",
      "title": "string",
      "description": "string",
      "department": {
        "id": "id",
        "name": "string"
      },
      "stepTemplates": [
        {
          "id": "id",
          "title": "string",
          "position": "int",
          "taskTemplates": [
            {
              "id": "id",
              "title": "string",
              "description": "string",
              "department": {
                "id": "id",
                "name": "string"
              },
              "useDepartmentCustomerRepresentative": "bool",
              "scheduleOffsetInDays": "int",
              "skipHolidayRule": "int",
              "inChargeUser": {
                "id": "id",
                "name": "string"
              },
              "position": "int",
              "subTasks": [
                {
                  "id": "id",
                  "processTemplateId": "id",
                  "taskTemplateId": "id",
                  "title": "string",
                  "position": "int",
                  "createdAt": "datetime",
                  "createdBy": "string",
                  "updatedAt": "datetime",
                  "updatedBy": "string"
                }
              ],
              "triggerTemplates": [
                {
                  "id": "id",
                  "triggerConditionType": "int",
                  "onTriggerSetNewStatus": "int",
                  "createdAt": "datetime",
                  "createdBy": "string",
                  "updatedAt": "datetime",
                  "updatedBy": "string"
                }
              ],
              "followers": [
                {
                  "userId": "id",
                  "name": "string"
                }
              ],
              "formTemplates": [
                {
                  "id": "id",
                  "name": "string",
                  "description": "string",
                  "department": {
                    "id": "id",
                    "name": "string"
                  },
                  "createdAt": "datetime",
                  "createdBy": "string",
                  "inactiveDate": "datetime",
                  "updatedAt": "datetime",
                  "updatedBy": "string"
                }
              ],
              "annotations": [
                {
                  "commentId": "id",
                  "comment": "string",
                  "createDate": "datetime",
                  "createUser": "string",
                  "files": [
                    {
                      "fileId": "id",
                      "contentType": "string",
                      "name": "string",
                      "size": "int"
                    }
                  ]
                }
              ],
              "files": [
                {
                  "fileId": "id",
                  "contentType": "string",
                  "name": "string",
                  "size": "int"
                }
              ],
              "createdAt": "datetime",
              "createdBy": "string",
              "updatedAt": "datetime",
              "updatedBy": "string"
            }
          ],
          "createdAt": "datetime",
          "createdBy": "string",
          "updatedAt": "datetime",
          "updatedBy": "string"
        }
      ],
      "createdAt": "datetime",
      "createdBy": "string",
      "updatedAt": "datetime",
      "updatedBy": "string"
    }
  ],
  "metadata": {
    "totalAllItems": "int",
    "total": "int"
  }
}