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-05-23T20:49:33.3633388+00:00", "CreatedBy": "a0fc3ff2-6527-4f3c-af59-9c44cca0576a", "ModifiedDate": "2025-05-23T20:49:33.3633388+00:00", "ModifiedBy": "278c2a93-d0ed-462d-880f-ddd79aa85db1", "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": [ "b064bdcf-035c-4db8-bf20-721be12bc5e7", "2fd03de5-e884-45f9-9094-48ad53f10713" ], "UserList": [ { "UserId": "8ad8daff-273f-4980-a24a-fb3bf2d0b541", "Permission": 0, "Inherited": true }, { "UserId": "8ad8daff-273f-4980-a24a-fb3bf2d0b541", "Permission": 0, "Inherited": true } ], "InheritedUserList": [ { "UserId": "8ad8daff-273f-4980-a24a-fb3bf2d0b541", "Permission": 0, "Inherited": true }, { "UserId": "8ad8daff-273f-4980-a24a-fb3bf2d0b541", "Permission": 0, "Inherited": true } ], "ParentId": "72d9324c-701b-4d7b-9147-463e08e289ac", "Views": [ { "Name": "sample string 1", "Id": "d3640982-caf8-4c9b-aa2c-67312b4285f2", "Filters": {}, "UserId": "2e691b27-5438-4855-8d9e-52d9ca7bc412", "Columns": [ "sample string 1", "sample string 2" ], "GanttCollapsed": true, "Personal": true, "PersonalUserId": "44134dce-9f66-410f-89a2-cc56be142a0f", "Default": true, "resourcePlanSettings": { "StartDateRange": "2025-05-23T20:49:33.3633388+00:00", "EndDateRange": "2025-05-23T20:49:33.3633388+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-05-23T20:49:33.3633388+00:00", "EndDateRange": "2025-05-23T20:49:33.3633388+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": "53ae4a5c-fb1d-4bb1-8280-bd2f0861b6d5", "yField": "b88a6708-ccdb-4ca1-9568-04841400f8a9", "sizeField": "1a6c2eb1-c05b-4434-9a9c-d45f74db7e42" } }, { "Name": "sample string 1", "Id": "d3640982-caf8-4c9b-aa2c-67312b4285f2", "Filters": {}, "UserId": "2e691b27-5438-4855-8d9e-52d9ca7bc412", "Columns": [ "sample string 1", "sample string 2" ], "GanttCollapsed": true, "Personal": true, "PersonalUserId": "44134dce-9f66-410f-89a2-cc56be142a0f", "Default": true, "resourcePlanSettings": { "StartDateRange": "2025-05-23T20:49:33.3633388+00:00", "EndDateRange": "2025-05-23T20:49:33.3633388+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-05-23T20:49:33.3633388+00:00", "EndDateRange": "2025-05-23T20:49:33.3633388+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": "53ae4a5c-fb1d-4bb1-8280-bd2f0861b6d5", "yField": "b88a6708-ccdb-4ca1-9568-04841400f8a9", "sizeField": "1a6c2eb1-c05b-4434-9a9c-d45f74db7e42" } } ], "LastCostPlannerTargets": [ { "CostTypeId": "cda19ace-d1c9-4bb5-bc32-8c042bfb9e02", "TargetData": { "2025-05-23T20:49:33.3633388+00:00": 2.0 } }, { "CostTypeId": "cda19ace-d1c9-4bb5-bc32-8c042bfb9e02", "TargetData": { "2025-05-23T20:49:33.3633388+00:00": 2.0 } } ], "CascadingLookupSelections": [ "04e4da28-2c09-4595-ba81-10a763edad03", "c2de93ae-c0d7-4ec5-b80b-80db0b450802" ], "CascadingLookupField": "80fa9df5-3522-4bf5-9a74-4d195a9dd0a4", "CloneOperation": true, "id": "31ab237f-2ca6-49de-a254-ac68e78a659c", "ConfigId": "c13a5b14-d5c6-4e41-966f-a65190ffcc8f" }