Listar as metas da empresa

GEThttps://api.azzimuti.com.br/v1/goals

Parâmetros de query

countnumber≥ 1≤ 100
Número de itens por página
Padrão: 10
pagenumber≥ 1
Número da página
Padrão: 1
searchstring
Busca pelo nome da meta (contém, sem diferenciar maiúsculas)
statusstring
Status da meta
Valores permitidos:ONGOINGACHIEVEDFAILED
activeAtstringdate-time
Data ou data e hora (ISO 8601). Retorna só as metas ativas nesse momento: início <= data <= fim. Metas sem início ou sem fim não entram.
indicatorIdstringuuid
ID do indicador ao qual a meta está ligada
countnumber≥ 1≤ 100
Número de itens por página
Padrão: 10
pagenumber≥ 1
Número da página
Padrão: 1
searchstring
Busca pelo nome da meta (contém, sem diferenciar maiúsculas)
statusstring
Status da meta
activeAtstringdate-time
Data ou data e hora (ISO 8601). Retorna só as metas ativas nesse momento: início <= data <= fim. Metas sem início ou sem fim não entram.
indicatorIdstringuuid
ID do indicador ao qual a meta está ligada

Respostas

200Lista de metas retornada com sucesso

Corpo da resposta

application/json

dataarray de objectsobrigatórioGoalPublicViewModel
data array de objects
Ver schema GoalPublicViewModel
paginationobjectobrigatórioPaginationMetaDto
pagination object
Ver schema PaginationMetaDto

Exemplo

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "objectiveValue": 0,
      "baselineValue": 0,
      "achievedValue": 0,
      "progress": 0,
      "status": "ONGOING",
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-01-01T00:00:00Z",
      "indicator": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "type": "PERCENT"
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "totalItems": 100,
    "perPage": 10,
    "currentPage": 1,
    "lastPage": 10
  }
}

Parâmetros de query

Respostas

Credenciais

Resposta