POST api/v2/IndicatorValues/{frequencia}

Salva valores (Real, Meta) de um determinado Indicador, em uma Frequência (Mensal, Semanal ou Diária) com uma data vinculada (Ocorrência). Os valores enviados podem ser do tipo Apurado ou Acumulado.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
frequencia

Pode receber os valores pelo nome [Mensal, Semanal, Diaria] ou pelo valor do Enumerador [1, 2, 3]

PortalSIM.Domain.Indicadores.Frequencia

Required

Body Parameters

Estrutura com os valores do Indicador. Para identificar o Indicador, pode ser usado o IdDoIndicador ou o CodigoDeInterface. O IdDoIndicador é um código interno que pode ser obtido na exportação dos Indicadores na Planilha e o CodigoDeInterface é um código customizável que pode ser configurado nas propriedades do Indicador.

PortalSIM.Domain.Performance.API.IndicatorValueAPI
NameDescriptionTypeAdditional information
IndicatorId

integer

Documentação não disponível

InterfaceCode

string

Documentação não disponível

IndicatorValues

Collection of PortalSIM.Domain.Performance.API.IndicatorValue

Documentação não disponível

Request Formats

application/json, text/json

Sample:
{
  "IndicatorId": 1,
  "InterfaceCode": "sample string 1",
  "IndicatorValues": [
    {
      "Occurrence": "2024-12-27T04:44:31.0997593+00:00",
      "Real": {
        "Value": 1.0
      },
      "Target": {
        "Value": 1.0
      },
      "ValueType": 1,
      "Programmed": {
        "Value": 1.0
      },
      "Projected": {
        "Value": 1.0
      }
    },
    {
      "Occurrence": "2024-12-27T04:44:31.0997593+00:00",
      "Real": {
        "Value": 1.0
      },
      "Target": {
        "Value": 1.0
      },
      "ValueType": 1,
      "Programmed": {
        "Value": 1.0
      },
      "Projected": {
        "Value": 1.0
      }
    }
  ]
}

application/xml, text/xml

Sample:
<IndicatorValueAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortalSIM.Domain.Performance.API">
  <IndicatorId>1</IndicatorId>
  <IndicatorValues>
    <IndicatorValue>
      <Occurrence>2024-12-27T04:44:31.0997593+00:00</Occurrence>
      <Programmed>
        <Value>1</Value>
      </Programmed>
      <Projected>
        <Value>1</Value>
      </Projected>
      <Real>
        <Value>1</Value>
      </Real>
      <Target>
        <Value>1</Value>
      </Target>
      <ValueType>Apurado</ValueType>
    </IndicatorValue>
    <IndicatorValue>
      <Occurrence>2024-12-27T04:44:31.0997593+00:00</Occurrence>
      <Programmed>
        <Value>1</Value>
      </Programmed>
      <Projected>
        <Value>1</Value>
      </Projected>
      <Real>
        <Value>1</Value>
      </Real>
      <Target>
        <Value>1</Value>
      </Target>
      <ValueType>Apurado</ValueType>
    </IndicatorValue>
  </IndicatorValues>
  <InterfaceCode>sample string 1</InterfaceCode>
</IndicatorValueAPI>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

200 OK. 400 BadRequest + Coleção de Erros.

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.