GET api/modeler/scenarios

Gets all scenarios based off the Config ID

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ModelScenario

Name	Type	Additional information
UserId	globally unique identifier	None.
Name	string	None.
ParentModelId	globally unique identifier	None.
Plans	Collection of ModelScenarioPlan	None.
Properties	Dictionary of string [key] and Object [value]	None.
TotalCheckedPlans	integer	None.
TotalPlans	integer	None.
TotalCostFields	Dictionary of string [key] and decimal number [value]	None.
TotalBenefitFields	Dictionary of string [key] and decimal number [value]	None.
TargetCostFields	Dictionary of string [key] and decimal number [value]	None.
TargetBenefitFields	Dictionary of string [key] and decimal number [value]	None.
CostPlannerTargets	Collection of ScenarioCostTarget	None.
id	globally unique identifier	None.
ConfigId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserId": "17db6184-413a-4c5e-96c2-b645fb107cbf",
    "Name": "sample string 2",
    "ParentModelId": "36d04de9-4c5c-4a5e-b68b-f17acd3e6a4e",
    "Plans": [
      {
        "PlanId": "709fee03-b0b1-4f29-b884-809df90090c2",
        "Name": "sample string 2",
        "InitialStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "InitialEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "Offset": 3.0,
        "Priority": 4.0,
        "Checked": true,
        "CostFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "BenefitFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "FilteredOut": true,
        "Fields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      {
        "PlanId": "709fee03-b0b1-4f29-b884-809df90090c2",
        "Name": "sample string 2",
        "InitialStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "InitialEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "Offset": 3.0,
        "Priority": 4.0,
        "Checked": true,
        "CostFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "BenefitFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "FilteredOut": true,
        "Fields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    ],
    "Properties": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "TotalCheckedPlans": 4,
    "TotalPlans": 5,
    "TotalCostFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "TotalBenefitFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "TargetCostFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "TargetBenefitFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "CostPlannerTargets": [
      {
        "CostTypeId": "5d761463-9dfe-44ab-af62-fe49e7533fac",
        "TargetData": {
          "2025-09-03T18:04:15.5543854+00:00": 2.0
        }
      },
      {
        "CostTypeId": "5d761463-9dfe-44ab-af62-fe49e7533fac",
        "TargetData": {
          "2025-09-03T18:04:15.5543854+00:00": 2.0
        }
      }
    ],
    "id": "599daf8e-512c-4ef7-aba6-a522f0751f45",
    "ConfigId": "7249f0d1-253c-4291-bcb1-20092846ad2d"
  },
  {
    "UserId": "17db6184-413a-4c5e-96c2-b645fb107cbf",
    "Name": "sample string 2",
    "ParentModelId": "36d04de9-4c5c-4a5e-b68b-f17acd3e6a4e",
    "Plans": [
      {
        "PlanId": "709fee03-b0b1-4f29-b884-809df90090c2",
        "Name": "sample string 2",
        "InitialStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "InitialEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "Offset": 3.0,
        "Priority": 4.0,
        "Checked": true,
        "CostFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "BenefitFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "FilteredOut": true,
        "Fields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      {
        "PlanId": "709fee03-b0b1-4f29-b884-809df90090c2",
        "Name": "sample string 2",
        "InitialStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "InitialEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedStartDate": "2025-09-03T18:04:15.5543854+00:00",
        "ShiftedEndDate": "2025-09-03T18:04:15.5543854+00:00",
        "Offset": 3.0,
        "Priority": 4.0,
        "Checked": true,
        "CostFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "BenefitFieldsValues": {
          "sample string 1": {},
          "sample string 3": {}
        },
        "FilteredOut": true,
        "Fields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    ],
    "Properties": {
      "sample string 1": {},
      "sample string 3": {}
    },
    "TotalCheckedPlans": 4,
    "TotalPlans": 5,
    "TotalCostFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "TotalBenefitFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "TargetCostFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "TargetBenefitFields": {
      "sample string 1": 2.0,
      "sample string 3": 4.0
    },
    "CostPlannerTargets": [
      {
        "CostTypeId": "5d761463-9dfe-44ab-af62-fe49e7533fac",
        "TargetData": {
          "2025-09-03T18:04:15.5543854+00:00": 2.0
        }
      },
      {
        "CostTypeId": "5d761463-9dfe-44ab-af62-fe49e7533fac",
        "TargetData": {
          "2025-09-03T18:04:15.5543854+00:00": 2.0
        }
      }
    ],
    "id": "599daf8e-512c-4ef7-aba6-a522f0751f45",
    "ConfigId": "7249f0d1-253c-4291-bcb1-20092846ad2d"
  }
]