Oms API GET Run Microdata compare

Read a "page" of microdata values and compare model runs.

Compare [base] and [variant] model runs microdata value attributes (float of integer type), group it by dimension attributes (enum-based or bool type).

Result can include multiple aggregated comparisons, grouped by multiple dimension attributes. Aggregated comparision(s) is a comma-separated list of Model Output Expressions of [base] and [variant] value attributes. For example, two comparisions: OM_AVG(Income[variant] - Income[base]) , OM_MAX( 100 * (Salary[variant] + Pension[variant]) / Income[base]) and group by two dimension attributes: AgeGroup , Sex.

Page is part of output table values defined by zero-based "start" row number and row count. If row count <= 0 then all rows returned.

It is also possible to use parameter(s) in calculation, parameter must be a scalar of float or integer type. For example: OM_COUNT_IF((Income[variant - Income[base]) > param.High[base]), where param.High[base] is a value of scalar parameter High in [base] model run.

Enum-based microdata attributes returned as enum codes.

Following aggregation functions avaliable:

• OM_AVG mean of accumulators sub-values
• OM_SUM sum of accumulators sub-values
• OM_COUNT count of accumulators sub-values (excluding NULL's)
• OM_COUNT_IF count values matching condition
• OM_MAX maximum of accumulators sub-values
• OM_MIN minimum of accumulators sub-values
• OM_VAR variance of accumulators sub-values
• OM_SD standard deviation of accumulators sub-values
• OM_SE standard error of accumulators sub-values
• OM_CV coefficient of variation of accumulators sub-values

For more details please see: Model Output Expressions

Methods:

GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/start/:start
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/start/:start/count/:count

Arguments:

:model - (required) model digest or model name

Model can be identified by digest or by model name. It is recommended to use digest because it is uniquely identifies model. It is possible to use model name, which is more human readable than digest, but if there are multiple models with same name in database than result is undefined.

:run     - (required) base model run digest, run stamp or run name
:variant - (required) variant model run(s): comma-separated list of digests, run stamps or run names

Model run can be identified by run digest, run stamp or run name. It is recommended to use digest because it is uniquely identifies model run. Run stamp, if not explicitly specified as model run option, automatically generated as timestamp string, ex.: 2016_08_17_21_07_55_123. It is also possible to use name, which is more human readable than digest, but if there are multiple runs with same name in database than result is undefined.

:name - (required) microdata entity name

:group-by - (required) comma-separated list of dimension attribute(s) to group by aggreagated values, dimension attribute must be enum-based or boolean type.

:compare - (required) comma-separated list of comparions of microdata value attribute(s), value attribute must be float of integer type.

:start - (optional) start "page" row number, zero-based.
:count - (optional) "page" size, number of rows to select, if count <= 0 then all rows selected.

Call examples:

http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database/start/2
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database/start/2/count/4

http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D),OM_AVG(Salary)/variant/Microdata%20other%20in%20database
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG((Income%5Bvariant%5D-Income%5Bbase%5D)+param.StartingSeed%5Bbase%5D)/variant/Microdata%20other%20in%20database

Note:

• OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D) is URL encoded: OM_AVG(Income[variant]-Income[base]).
• OM_AVG((Income%5Bvariant%5D-Income%5Bbase%5D)+param.StartingSeed%5Bbase%5D) is URL encoded: OM_AVG((Income[variant]-Income[base])+param.StartingSeed[base]).

Return example:

http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/group-by/AgeGroup,Sex/compare/OM_AVG(Income%5Bvariant%5D-Income%5Bbase%5D)/variant/Microdata%20other%20in%20database

[
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "10-20"
      },
      {
        "IsNull": false,
        "Value": "M"
      },
      {
        "IsNull": false,
        "Value": -6701256.201619063
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "10-20"
      },
      {
        "IsNull": false,
        "Value": "F"
      },
      {
        "IsNull": false,
        "Value": -6702689.143904675
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "20-30"
      },
      {
        "IsNull": false,
        "Value": "M"
      },
      {
        "IsNull": false,
        "Value": -67108864
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "20-30"
      },
      {
        "IsNull": false,
        "Value": "F"
      },
      {
        "IsNull": false,
        "Value": -67112960
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "30-40"
      },
      {
        "IsNull": false,
        "Value": "M"
      },
      {
        "IsNull": false,
        "Value": -67149824
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "30-40"
      },
      {
        "IsNull": false,
        "Value": "F"
      },
      {
        "IsNull": false,
        "Value": -67153920
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "40+"
      },
      {
        "IsNull": false,
        "Value": "M"
      },
      {
        "IsNull": false,
        "Value": -37327458.47071971
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  },
  {
    "Attr": [
      {
        "IsNull": false,
        "Value": "40+"
      },
      {
        "IsNull": false,
        "Value": "F"
      },
      {
        "IsNull": false,
        "Value": -35538991.09092548
      }
    ],
    "CalcName": "ex_12000",
    "RunDigest": "86135ceed94d1239937a42e088a7fcb7"
  }
]