Objetivo

A API permite consultar todas as sequências de aprovação cadastradas no ContractPlus.

O retorno apresenta, para cada sequência:

• O identificador interno;

• A ordem funcional da sequência;

• O local de aprovação;

• O nome da sequência;

• Os usuários aprovadores vinculados.

Endpoint

GET /api/ApprovalSequence

Autenticação

A requisição exige autenticação válida.

Authorization: Bearer {{token}}

Caso a requisição seja realizada sem autenticação válida, a API retorna:

401 Unauthorized

Cabeçalhos

Authorization: Bearer {{token}}
Accept: application/json

A requisição não possui corpo.

Exemplo de requisição

GET http://localhost:{{host}}/api/ApprovalSequence

Resposta de sucesso

Status esperado

200 OK

Exemplo

[
  {
    "Id": 101,
    "SeqId": 1,
    "PlaceId": 2,
    "Name": "Adiantamento - Nível 1",
    "Users": [
      {
        "Id": 201,
        "UserName": "aprovador.nivel1"
      }
    ]
  },
  {
    "Id": 102,
    "SeqId": 2,
    "PlaceId": 2,
    "Name": "Adiantamento - Nível 2",
    "Users": [
      {
        "Id": 202,
        "UserName": "aprovador.nivel2"
      },
      {
        "Id": 203,
        "UserName": "aprovador.substituto"
      }
    ]
  }
]

A resposta é apresentada como um array JSON, contendo todas as sequências cadastradas.

Estrutura da resposta

Campo Id

O campo Id representa o identificador interno da sequência cadastrada.

Exemplo:

{
  "Id": 101
}

Esse identificador pode ser utilizado em operações específicas sobre a sequência, como consulta individual, alteração ou exclusão.

Campo SeqId

O campo SeqId representa a posição funcional da sequência no fluxo de aprovação.

Exemplo:

{
  "SeqId": 2
}

Nesse caso, a sequência representa o segundo nível do fluxo.

O SeqId não deve ser confundido com o Id interno do registro.

Campo PlaceId

O campo PlaceId indica o processo ao qual a sequência pertence.

Para sequências de aprovação, são utilizados:

Campo Name

O campo Name apresenta a descrição cadastrada para a sequência.

Exemplo:

{
  "Name": "Retenção Técnica - Nível 1"
}

Usuários vinculados

O campo Users apresenta os aprovadores vinculados à sequência.

Exemplo:

{
  "Users": [
    {
      "Id": 201,
      "UserName": "aprovador.nivel1"
    },
    {
      "Id": 202,
      "UserName": "aprovador.nivel2"
    }
  ]
}

Cada usuário contém:

O campo UserName representa o código utilizado pelo usuário no sistema.

Sequências com múltiplos usuários

Uma mesma sequência pode possuir mais de um aprovador.

Exemplo:

{
  "Id": 102,
  "SeqId": 2,
  "PlaceId": 2,
  "Name": "Adiantamento - Nível 2",
  "Users": [
    {
      "Id": 202,
      "UserName": "aprovador.financeiro"
    },
    {
      "Id": 203,
      "UserName": "aprovador.gerencial"
    }
  ]
}

Todos os usuários vinculados são retornados dentro do array Users.

Consulta com diferentes locais de aprovação

O retorno pode conter sequências de mais de um local de aprovação.

Exemplo:

[
  {
    "Id": 101,
    "SeqId": 1,
    "PlaceId": 2,
    "Name": "Adiantamento - Nível 1",
    "Users": [
      {
        "Id": 201,
        "UserName": "aprovador.adiantamento"
      }
    ]
  },
  {
    "Id": 105,
    "SeqId": 1,
    "PlaceId": 4,
    "Name": "Retenção Técnica - Nível 1",
    "Users": [
      {
        "Id": 210,
        "UserName": "aprovador.retencao"
      }
    ]
  }
]

A identificação do processo deve ser realizada pelo valor de PlaceId.

Base sem sequências cadastradas

Caso não existam sequências cadastradas, a API continua retornando:

200 OK

Com um array vazio:

[]

A ausência de registros não resulta em erro 404 ou 500.

Como utilizar

1. Autentique-se na API.

2. Envie uma requisição:

GET /api/ApprovalSequence

3. Percorra o array retornado.

4. Utilize o campo PlaceId para identificar o processo.

5. Utilize o SeqId para identificar a ordem funcional.

6. Consulte o array Users para obter os aprovadores vinculados.

7. Utilize o campo Id quando for necessário executar uma operação específica sobre determinada sequência.

Comportamento esperado

Pontos de atenção

• O endpoint utiliza o método GET.

• A requisição não possui corpo.

• O retorno é sempre um array na consulta geral.

• O campo Id identifica internamente a sequência.

• O campo SeqId determina sua ordem funcional.

• O campo PlaceId identifica o processo de aprovação.

• O array Users contém todos os aprovadores vinculados.

• UserName representa o código de login do aprovador.

• Uma sequência pode possuir múltiplos usuários.

• Sequências de diferentes locais podem ser retornadas na mesma consulta.

• Caso não existam registros, será retornado um array vazio.

• O endpoint exige autenticação Bearer.