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-04-04T02:35:13.1996473+00:00", "CreatedBy": "97a314ec-bcc5-4c0f-9072-5c6b7d9541f8", "ModifiedDate": "2025-04-04T02:35:13.1996473+00:00", "ModifiedBy": "1a20e077-953e-47a4-9c75-5e24b78c5679", "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": [ "468a82b6-a0e0-4c54-a6b6-3ecf1e2dd113", "6b2875ce-00e7-4650-b7f3-02379ade63f2" ], "UserList": [ { "UserId": "e72f486f-15e1-447f-8126-98a2b58a45f4", "Permission": 0, "Inherited": true }, { "UserId": "e72f486f-15e1-447f-8126-98a2b58a45f4", "Permission": 0, "Inherited": true } ], "InheritedUserList": [ { "UserId": "e72f486f-15e1-447f-8126-98a2b58a45f4", "Permission": 0, "Inherited": true }, { "UserId": "e72f486f-15e1-447f-8126-98a2b58a45f4", "Permission": 0, "Inherited": true } ], "ParentId": "fff010d3-ea83-4be3-963a-83329e8f6943", "Views": [ { "Name": "sample string 1", "Id": "9eb7fc6f-9785-426e-8a09-a490df8562f6", "Filters": {}, "UserId": "3ddf382d-3937-40cf-8a68-b98ebf2f6b87", "Columns": [ "sample string 1", "sample string 2" ], "GanttCollapsed": true, "Personal": true, "PersonalUserId": "95f7abb4-c8d3-4531-ac5d-ef471fa4bf09", "Default": true, "resourcePlanSettings": { "StartDateRange": "2025-04-04T02:35:13.1996473+00:00", "EndDateRange": "2025-04-04T02:35:13.1996473+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-04-04T02:35:13.1996473+00:00", "EndDateRange": "2025-04-04T02:35:13.1996473+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": "c1a6ac24-e2c4-484c-9101-8023847d6f3c", "yField": "dc4ff837-4dfe-4d52-9962-fd4f9af97bfa", "sizeField": "25df3a4d-79ca-4656-bcf0-454ded73a10b" } }, { "Name": "sample string 1", "Id": "9eb7fc6f-9785-426e-8a09-a490df8562f6", "Filters": {}, "UserId": "3ddf382d-3937-40cf-8a68-b98ebf2f6b87", "Columns": [ "sample string 1", "sample string 2" ], "GanttCollapsed": true, "Personal": true, "PersonalUserId": "95f7abb4-c8d3-4531-ac5d-ef471fa4bf09", "Default": true, "resourcePlanSettings": { "StartDateRange": "2025-04-04T02:35:13.1996473+00:00", "EndDateRange": "2025-04-04T02:35:13.1996473+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-04-04T02:35:13.1996473+00:00", "EndDateRange": "2025-04-04T02:35:13.1996473+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": "c1a6ac24-e2c4-484c-9101-8023847d6f3c", "yField": "dc4ff837-4dfe-4d52-9962-fd4f9af97bfa", "sizeField": "25df3a4d-79ca-4656-bcf0-454ded73a10b" } } ], "LastCostPlannerTargets": [ { "CostTypeId": "c4513b24-4241-41d7-bebd-6b9e923aca10", "TargetData": { "2025-04-04T02:35:13.1996473+00:00": 2.0 } }, { "CostTypeId": "c4513b24-4241-41d7-bebd-6b9e923aca10", "TargetData": { "2025-04-04T02:35:13.1996473+00:00": 2.0 } } ], "CascadingLookupSelections": [ "39bafe63-d606-4f45-94cb-510879d7d6c7", "88a3f321-6e88-49cb-bb93-9411e777a9a6" ], "CascadingLookupField": "7aa0e613-9090-4298-bb7a-a6b9cdb0aa48", "CloneOperation": true, "id": "9d2b5926-a518-4c86-89da-8127162d4e88", "ConfigId": "901ee5b3-6299-4e5c-a2dc-e7604b09ea54" }