Writeback CRUD Operations

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.5.x. To view documentation for other Kyvos versions, click here.

Resources

Below is an example of JSON structure which can be used as a reference for the positionsJson parameter in the request body.

[
  {
    "members": [
      {
        "id": "DIM_328688~$~H_624475~$~1~$~2012",
        "fieldType": "LEVEL",
        "name": "2012"
      },
      {
        "id": "DIM_906~$~H_1798~$~1~$~7",
        "fieldType": "LEVEL",
        "name": "7"
      },
      {
        "id": "DIM_458~$~DIMENSION_ATTRIBUTE_939~$~19",
        "fieldType": "ATTRIBUTE",
        "name": "19"
      },
      {
        "id": "DIM_763~$~DIMENSION_ATTRIBUTE_2546~$~19",
        "fieldType": "ATTRIBUTE",
        "name": "19"
      },
      {
        "id": "DIM_945~$~H_1861~$~1~$~Actual",
        "fieldType": "LEVEL",
        "name": "Actual"
      },
      {
        "id": "MEASURE_2010",
        "fieldType": "MEASURE",
        "name": ""
      }
    ],
    "filters": [
      {
        "fieldName": "DIM_175!!!H_270!!!DIMENSION_LEVEL_648",
        "operation": "NOT_EQUAL_TO",
        "dataType": "CHAR",
        "filterType": "QUICK",
        "fieldType": "DIMENSION",
        "relation": "AND",
        "valueType": "predefined",
        "valueBy": "VALUE",
        "startEnclosure": "",
        "endEnclosure": "",
        "firstValue": "Canada",
        "firstDisplayValue": "Canada",
        "secondValue": "",
        "secondDisplayValue": "",
        "fieldDisplayName": "Country",
        "displayValueDateFormat": ""
      },
      {
        "fieldName": "DIM_328688!!!DIMENSION_ATTRIBUTE_547593",
        "operation": "INLIST",
        "dataType": "DATE",
        "filterType": "QUICK",
        "fieldType": "DIMENSION",
        "relation": "AND",
        "valueType": "predefined",
        "valueBy": "VALUE",
        "startEnclosure": "",
        "endEnclosure": "",
        "firstValue": "'2012-01-29 00:00:00.0'",
        "firstDisplayValue": "2012/01/29",
        "secondValue": "",
        "secondDisplayValue": "",
        "fieldDisplayName": "Order Date",
        "isFirstValueFromPredefList": false,
        "isSecondValueFromPredefList": false,
        "displayValueDateFormat": "yyyy/MM/dd"
      },
      {
        "fieldName": "DIM_763!!!H_1560!!!DIMENSION_LEVEL_4573",
        "operation": "STARTSWITHIGNORECASE",
        "dataType": "CHAR",
        "filterType": "QUICK",
        "fieldType": "DIMENSION",
        "relation": "AND",
        "valueType": "predefined",
        "valueBy": "VALUE",
        "startEnclosure": "",
        "endEnclosure": "",
        "firstValue": "C",
        "firstDisplayValue": "C",
        "secondValue": "",
        "secondDisplayValue": "",
        "fieldDisplayName": "Organizations"
      },
      {
        "fieldName": "DIM_815!!!DIMENSION_ATTRIBUTE_2803",
        "operation": "INLIST",
        "dataType": "NUMBER",
        "filterType": "QUICK",
        "fieldType": "DIMENSION",
        "relation": "AND",
        "valueType": "predefined",
        "valueBy": "VALUE",
        "startEnclosure": "",
        "endEnclosure": "",
        "firstValue": "'1170'",
        "firstDisplayValue": "1170",
        "secondValue": "",
        "secondDisplayValue": "",
        "fieldDisplayName": "Account Number"
      }
    ],
    "originalValue": "222797",
    "prevValue": "222797",
    "updatedValue": "222799"
  }
]