Buscar uma meta por ID

GEThttps://api.azzimuti.com.br/v1/goals/{id}

Parâmetros de path

idstringobrigatóriouuid
ID da meta

Respostas

200Meta encontrada com sucesso

Corpo da resposta

application/json

idstringobrigatóriouuid
ID da meta
namestringobrigatório
Nome da meta
descriptionstringobrigatóriopode ser nulo
Descrição da meta
objectiveValuenumberobrigatório
Valor objetivo da meta
baselineValuenumberobrigatório
Valor de partida da meta
achievedValuenumberobrigatóriopode ser nulo
Valor atingido: último valor registrado no indicador. Nulo se ainda não há valor.
progressnumberobrigatório
Progresso da meta, em porcentagem
statusstringobrigatório
Status da meta
Valores permitidos:ONGOINGACHIEVEDFAILED
startDatestringobrigatóriodate-timepode ser nulo
Início da vigência da meta
endDatestringobrigatóriodate-timepode ser nulo
Fim da vigência da meta
indicatorobjectobrigatóriopode ser nuloGoalIndicatorPublicViewModel
Indicador ao qual a meta está ligada
indicator object
Ver schema GoalIndicatorPublicViewModel
createdAtstringobrigatóriodate-time
Data de criação da meta
updatedAtstringobrigatóriodate-time
Data da última atualização da meta

Exemplo

{
  "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"
}

404Meta não encontrada

Sem corpo de resposta.

Parâmetros de path

Respostas

Credenciais

Resposta