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
ModelerModelName | Description | 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": "2025-09-17T18:48:04.2436865+00:00", "CreatedBy": "3862dd1f-78df-4c67-90b7-d1deeb0bf17f", "ModifiedDate": "2025-09-17T18:48:04.2436865+00:00", "ModifiedBy": "76243a14-592f-4b39-b3d3-ddd8a885ac04", "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": [ "31e51ddc-c5b7-488b-8766-8007cb51b267", "495de099-fd24-46aa-9bb4-eee2c1fe1f8f" ], "UserList": [ { "UserId": "b27582f5-2c3a-4626-8b88-e3c7509f471c", "Permission": 0, "Inherited": true }, { "UserId": "b27582f5-2c3a-4626-8b88-e3c7509f471c", "Permission": 0, "Inherited": true } ], "InheritedUserList": [ { "UserId": "b27582f5-2c3a-4626-8b88-e3c7509f471c", "Permission": 0, "Inherited": true }, { "UserId": "b27582f5-2c3a-4626-8b88-e3c7509f471c", "Permission": 0, "Inherited": true } ], "ParentId": "e968c01a-dc03-4758-836b-e84b0b79be45", "Views": [ { "Name": "sample string 1", "Id": "8a9e0a37-edf0-4086-a140-5fad4fc82bbe", "Filters": {}, "UserId": "32bd8759-6775-46e2-b1dc-47e9f5fb53b6", "Columns": [ "sample string 1", "sample string 2" ], "GanttCollapsed": true, "Personal": true, "PersonalUserId": "02d5d8f4-e091-4ec9-83ec-52ca8dc8d2ee", "Default": true, "resourcePlanSettings": { "StartDateRange": "2025-09-17T18:48:04.2436865+00:00", "EndDateRange": "2025-09-17T18:48:04.2436865+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": "2025-09-17T18:48:04.2436865+00:00", "EndDateRange": "2025-09-17T18:48:04.2436865+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": "068c03a9-98c8-47ef-837c-bed51a9babb0", "yField": "ceeae846-4217-4a1f-9d6c-5db69e7e11ed", "sizeField": "dd166d19-243f-4d06-9934-5e58eb06bf93" } }, { "Name": "sample string 1", "Id": "8a9e0a37-edf0-4086-a140-5fad4fc82bbe", "Filters": {}, "UserId": "32bd8759-6775-46e2-b1dc-47e9f5fb53b6", "Columns": [ "sample string 1", "sample string 2" ], "GanttCollapsed": true, "Personal": true, "PersonalUserId": "02d5d8f4-e091-4ec9-83ec-52ca8dc8d2ee", "Default": true, "resourcePlanSettings": { "StartDateRange": "2025-09-17T18:48:04.2436865+00:00", "EndDateRange": "2025-09-17T18:48:04.2436865+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": "2025-09-17T18:48:04.2436865+00:00", "EndDateRange": "2025-09-17T18:48:04.2436865+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": "068c03a9-98c8-47ef-837c-bed51a9babb0", "yField": "ceeae846-4217-4a1f-9d6c-5db69e7e11ed", "sizeField": "dd166d19-243f-4d06-9934-5e58eb06bf93" } } ], "LastCostPlannerTargets": [ { "CostTypeId": "e63f56de-15ba-43b5-bee0-caac27502a2f", "TargetData": { "2025-09-17T18:48:04.2436865+00:00": 2.0 } }, { "CostTypeId": "e63f56de-15ba-43b5-bee0-caac27502a2f", "TargetData": { "2025-09-17T18:48:04.2436865+00:00": 2.0 } } ], "CascadingLookupSelections": [ "4320f8c2-ce32-4be9-9e08-fa74be9aaa0f", "300b7d66-934f-4763-81b8-de705b3c2e00" ], "CascadingLookupField": "df93f7d2-b9b7-4213-80bb-c5bb44bff425", "CloneOperation": true, "id": "04a1b9d6-d2c7-47db-89ba-9564851f0cae", "ConfigId": "dc4dd645-5b63-4fe7-b855-2531eb5aeb5e" }