GET api/modeler/model?id={id}

Gets a single model based off of the ID

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

ModelerModel

Name	Type	Additional information
Name	string	None.
Description	string	None.
CreatedDate	date	None.
CreatedBy	globally unique identifier	None.
ModifiedDate	date	None.
ModifiedBy	globally unique identifier	None.
ModifiedByName	string	None.
ModifiedByPictureID	string	None.
Filter	string	None.
ScenarioCount	integer	None.
CostFields	Collection of string	None.
BenefitsFields	Collection of string	None.
SortField	string	None.
SortDirection	SortByDirection	None.
CostTypes	Collection of globally unique identifier	None.
UserList	Collection of User	None.
InheritedUserList	Collection of User	None.
ParentId	globally unique identifier	None.
Views	Collection of ModelView	None.
LastCostPlannerTargets	Collection of ScenarioCostTarget	None.
CascadingLookupSelections	Collection of globally unique identifier	None.
CascadingLookupField	globally unique identifier	None.
CloneOperation	boolean	None.
id	globally unique identifier	None.
ConfigId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "CreatedDate": "2024-10-18T08:37:41.382551+00:00",
  "CreatedBy": "79c952b2-dbb4-422f-93d6-7aa58f06dbb8",
  "ModifiedDate": "2024-10-18T08:37:41.382551+00:00",
  "ModifiedBy": "5d96423a-6e73-4154-9f97-05e84996987e",
  "ModifiedByName": "sample string 7",
  "ModifiedByPictureID": "sample string 8",
  "Filter": "sample string 9",
  "ScenarioCount": 10,
  "CostFields": [
    "sample string 1",
    "sample string 2"
  ],
  "BenefitsFields": [
    "sample string 1",
    "sample string 2"
  ],
  "SortField": "sample string 11",
  "SortDirection": 0,
  "CostTypes": [
    "a5023650-dd19-4ec4-981f-b80263de49d5",
    "7a1f6497-d5a3-42b4-832c-a8146835af65"
  ],
  "UserList": [
    {
      "UserId": "e3396c65-0028-4201-8025-7191c5db9980",
      "Permission": 0,
      "Inherited": true
    },
    {
      "UserId": "e3396c65-0028-4201-8025-7191c5db9980",
      "Permission": 0,
      "Inherited": true
    }
  ],
  "InheritedUserList": [
    {
      "UserId": "e3396c65-0028-4201-8025-7191c5db9980",
      "Permission": 0,
      "Inherited": true
    },
    {
      "UserId": "e3396c65-0028-4201-8025-7191c5db9980",
      "Permission": 0,
      "Inherited": true
    }
  ],
  "ParentId": "d877858f-3e33-475b-912c-67be8f0d9082",
  "Views": [
    {
      "Name": "sample string 1",
      "Id": "a4567409-ef7a-4b00-aeb4-7a0497defb78",
      "Filters": {},
      "UserId": "badf31a6-fff7-4b21-b49b-19f971f4ea72",
      "Columns": [
        "sample string 1",
        "sample string 2"
      ],
      "GanttCollapsed": true,
      "Personal": true,
      "PersonalUserId": "69b23947-264f-4517-996c-a865c302bd00",
      "Default": true,
      "resourcePlanSettings": {
        "StartDateRange": "2024-10-18T08:37:41.382551+00:00",
        "EndDateRange": "2024-10-18T08:37:41.382551+00:00",
        "ZoomLevel": 3,
        "Filters": "sample string 4",
        "GroupBy": "sample string 5",
        "FTEMode": 6,
        "CostType": "sample string 7",
        "DataSelection_Resources": "sample string 8",
        "DataSelection_Plans": "sample string 9",
        "DataSelection_Lines": "sample string 10",
        "VisibleGridColumns": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "costPlanSettings": {
        "StartDateRange": "2024-10-18T08:37:41.382551+00:00",
        "EndDateRange": "2024-10-18T08:37:41.382551+00:00",
        "CostType": "sample string 3",
        "AdditionalCostTypes": [
          "sample string 1",
          "sample string 2"
        ],
        "ZoomLevel": 4,
        "ExchangeCurrencyValue": "sample string 5"
      },
      "ChartView": true,
      "chartType": 0,
      "bubbleChartSettings": {
        "xField": "e2190e25-805c-4559-ad48-eeb9b98ea1c0",
        "yField": "3d32020b-1d8e-48f9-9219-3f5f72c4ea18",
        "sizeField": "8cf44f26-b9c8-4d37-ad97-cfa8a41e499f"
      }
    },
    {
      "Name": "sample string 1",
      "Id": "a4567409-ef7a-4b00-aeb4-7a0497defb78",
      "Filters": {},
      "UserId": "badf31a6-fff7-4b21-b49b-19f971f4ea72",
      "Columns": [
        "sample string 1",
        "sample string 2"
      ],
      "GanttCollapsed": true,
      "Personal": true,
      "PersonalUserId": "69b23947-264f-4517-996c-a865c302bd00",
      "Default": true,
      "resourcePlanSettings": {
        "StartDateRange": "2024-10-18T08:37:41.382551+00:00",
        "EndDateRange": "2024-10-18T08:37:41.382551+00:00",
        "ZoomLevel": 3,
        "Filters": "sample string 4",
        "GroupBy": "sample string 5",
        "FTEMode": 6,
        "CostType": "sample string 7",
        "DataSelection_Resources": "sample string 8",
        "DataSelection_Plans": "sample string 9",
        "DataSelection_Lines": "sample string 10",
        "VisibleGridColumns": [
          "sample string 1",
          "sample string 2"
        ]
      },
      "costPlanSettings": {
        "StartDateRange": "2024-10-18T08:37:41.382551+00:00",
        "EndDateRange": "2024-10-18T08:37:41.382551+00:00",
        "CostType": "sample string 3",
        "AdditionalCostTypes": [
          "sample string 1",
          "sample string 2"
        ],
        "ZoomLevel": 4,
        "ExchangeCurrencyValue": "sample string 5"
      },
      "ChartView": true,
      "chartType": 0,
      "bubbleChartSettings": {
        "xField": "e2190e25-805c-4559-ad48-eeb9b98ea1c0",
        "yField": "3d32020b-1d8e-48f9-9219-3f5f72c4ea18",
        "sizeField": "8cf44f26-b9c8-4d37-ad97-cfa8a41e499f"
      }
    }
  ],
  "LastCostPlannerTargets": [
    {
      "CostTypeId": "f3aa6fe7-9c68-4109-9d97-1ac99c7694a9",
      "TargetData": {
        "2024-10-18T08:37:41.382551+00:00": 2.0
      }
    },
    {
      "CostTypeId": "f3aa6fe7-9c68-4109-9d97-1ac99c7694a9",
      "TargetData": {
        "2024-10-18T08:37:41.382551+00:00": 2.0
      }
    }
  ],
  "CascadingLookupSelections": [
    "6838c7d4-cb5d-4581-9546-d0143bc5739b",
    "fae1c2fc-397e-41ef-88b6-82e5d734d1f1"
  ],
  "CascadingLookupField": "a80f4837-2536-44b7-b68e-927ed25a24db",
  "CloneOperation": true,
  "id": "8441453e-0b18-44f9-bb22-d77dc361a556",
  "ConfigId": "79a34a37-3e54-42d1-8e41-815e0ff0c028"
}