Руководство администратора
×
Меню
Индекс
Поиск
 
   
   
   
 
  (c) ПрофИтПроект, 2024

api/v1/CalculationManager/CalculateIndicatorsScoreCardExternal - Расчет карты KPI для внешних приложений

 
Метод вызова
POST
 
Описание
Возвращает расчет Карты KPI
 
Формат запроса
http://localhost:51496/WCFSrvKPIWebUIAPI.svc/api/v1/CalculationManager/CalculateIndicatorsScoreCardExternal
 
Запрос
header:
  "access-token-numberID":  -- /* заполняется из ответа команды авторизации */
  "access-token-sessionID": -- /* заполняется из ответа команды авторизации */
body:  {
    "parameters": {
    "employee": 20,                          --/* ID сотрудника*/
    "orgStructureElement": 0,                --/* ID элемента оргструктуры*/
    "buildDate": "2019-01-01T00:00:00.000",  --/* Конец периода расчета карты */
    "typePeriod":                            --/* Шаг периода */
               EveryMonth                    --/* Ежемесячно */
             | EveryQuarter                  --/* Ежеквартально */
             | EveryHalf                     --/* Ежеквартально */
             | EveryYear                     --/* Ежегодно */
             | Every9Month                   --/* Ежегодно */
          ,
    "workItemsFieldNames": [                 --/* Массив  итоговых полей карты */
             "value"                         --/* Плановый размер коэффициента */
            | "actualValue"                  --/* Фактический размер коэффициента */
            | "weightValue"                  --/* Итоги взвешенной оценки значений */
            | "acceptValue"                  --/* Коэффициент оценки */
            | "totalValue"                   --/* Итоговый размер коэффициента */
            | "<код пользовательского поля>" -- /* например, ATarget */
            | "*"                            -- /* все поля */
            ...
     ],
     "rowItemsByCodeIndicator": [
             "<Код показателя в строке карты>" -- /* все строки табличной части */
            | "*"                              --/* строки  карты по коду показателя */
            ...
     ],
     "scoreItemsFieldNames": [                 --/* Массив полей элементов карты */
             "actualValue"                     --/* Факт */
            | "planValue"                      --/* План */
            | "percentageOfCompletion"         --/* Процент выполнения */
            | "weightValue"                    --/* Взвешенный % выполнения */
            | "actualDiscreteValue"            --/* Факт качественного показателя */
            | "planDiscreteValue"              --/* План качественного показателя */
            | "<код пользовательского поля>"   -- /* например, ATarget_by_item*/
            | "*"                              -- /* все поля табличной части */
            ...
     ]      
  }
}
 
Результат в формате JSON
body: {
      "parameters": { }, -- /* тот же объект, что и в запросе */
      "scoreCards": [{ -- /* Массив запрошенных элементов карт по ID - сотрудника по все перемещениям за период */
        "workItems": [ -- /* итоговые значения карты*/
            {
               "actualValue":  { "title": "Фактический размер коэффициента", "value": 41380, "outputformat": "#0 000.00 руб."}, --/* Запрашиваемое итоговое поле */
               "ATarget":           { "title": "Амцель", "value": 41380, "outputformat": "#0 000.00 руб."}                      --/* Запрашиваемое пользовательское итоговое поле" */
          }
            ...],
         
        "scoreItems":[     -- /* строка карты KPI, если указан Код показателя, или все строки карты */
            {
               "code": "Код89",
               "name": "Размер переменной части заработной платы",
               "zeroReplacer": "-",
               "actualValue":      { "value": 41380, "outputformat": "#0 000.00 руб."},     --/* Факт запрашиваемого показателя */
               "ATarget_by_item":     { "value": 41380, "outputformat": "#0 000.00 руб."}    --/* Значение пользовательского поля табличной части карты  запрашиваемого показателя */
            }
            ...]
       }
        ...]
}
 
 
Пример расчета Карты KPI
 
Шаг 1. Авторизация (пример)
Шаг 2. Расчет карты KPI
 
Пример запроса
headers {
"Content-Type"    : "application/json; charset=utf-8",
"Connection"      : "Keep-Alive",
"Accept-Encoding" : "gzip, deflate",
"Expect"          : "100-continue",
"access-token-numberID"  : "fa71811c-d603-4293-828f-44e51f34849d",
"access-token-sessionID" : "bb43889f-d688-4809-9d26-255e59cbd1cc@9ff53b19-15e7-4c50-bd60-ed2c593dfe37@6eea308c-4e58-4614-a568-3268922107f1",
}
body:  {
    "parameters": {
        "employee": 20,
        "orgStructureElement": 0,
        "buildDate": "2019-01-01T00:00:00.000",
        "typePeriod": "EveryMonth",
        "workItemsFieldNames": ["actualValue","ATarget"],
        "rowItemsByCodeIndicator": ["Код89"],
        "scoreItemsFieldNames": ["actualValue","ATarget_by_item"]
  }
}
 
Пример результата в формате JSON
body: {
    "parameters": {
        "employee": 20,
        "orgStructureElement": 0,
        "buildDate": "2019-01-01T00:00:00.000",
        "typePeriod": "EveryMonth",
        "workItemsFieldNames": ["actualValue","ATarget"],
        "rowItemsByCodeIndicator": ["Код89"],
        "scoreItemsFieldNames": ["actualValue","ATarget_by_item"]
    }
   "scoreCards": [{
       "workItems": [{
               "actualValue": { "title": "Фактический размер коэффициента", "value": 41380, "outputformat": "#0 000.00 руб."},
               "ATarget": { "title": "Амцель", "value": 41380, "outputformat": "#0 000.00 руб."} 
        }],
       "scoreItems":[{
               "code": "Код89",
               "name": "Размер переменной части заработной платы",
               "zeroReplacer": "-",
               "actualValue": { "value": 41380, "outputformat": "#0 000.00 руб."},
               "ATarget_by_item": { "value": 41380, "outputformat": "#0 000.00 руб."} 
          }]
     },
     {
       "workItems": [{
               "actualValue": { "title": "Фактический размер коэффициента", "value": 52724, "outputformat": "#0 000.00 руб."},
               "ATarget": { "title": "Амцель", "value": 57246, "outputformat": "#0 000.00 руб."} 
        }],
       "scoreItems":[{
               "code": "Код89",
               "name": "Размер переменной части заработной платы",
               "zeroReplacer": "-",
               "actualValue": { "value": 51380, "outputformat": "#0 000.00 руб."},
               "ATarget_by_item": { "value": 49876, "outputformat": "#0 000.00 руб."} 
          }]
     }]
}
Справочная система создана в Dr.Explain