POST api/modeler/new
Creates a new model or updates one depending on if the ID exists or not
Request Information
URI Parameters
None.
Body Parameters
ModelerModel| Name | 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. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Description": "sample string 2",
"CreatedDate": "2025-07-11T14:30:26.7650109+00:00",
"CreatedBy": "51a07519-2ab7-4bf5-a17b-3a3021295313",
"ModifiedDate": "2025-07-11T14:30:26.7650109+00:00",
"ModifiedBy": "284f63f4-3e24-433a-adf3-b3a2a0568e45",
"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": [
"25bb7dfc-e14c-4d5a-952a-5b14d3d74769",
"14472f2c-e829-4ad7-82d3-f5c1632fbeab"
],
"UserList": [
{
"UserId": "110a8f5e-4f21-4da7-abe1-eba01b39e716",
"Permission": 0,
"Inherited": true
},
{
"UserId": "110a8f5e-4f21-4da7-abe1-eba01b39e716",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "110a8f5e-4f21-4da7-abe1-eba01b39e716",
"Permission": 0,
"Inherited": true
},
{
"UserId": "110a8f5e-4f21-4da7-abe1-eba01b39e716",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "bef378c3-5264-4b77-89a7-08047fb00a0b",
"Views": [
{
"Name": "sample string 1",
"Id": "7d752fc8-44df-4855-8cce-e71d9fffe6c5",
"Filters": {},
"UserId": "8c87a93d-ba01-4139-812b-da1875471a53",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "da42a33d-54b1-4dc0-843a-5c4f53f210ad",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-07-11T14:30:26.7650109+00:00",
"EndDateRange": "2025-07-11T14:30:26.7650109+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-07-11T14:30:26.7650109+00:00",
"EndDateRange": "2025-07-11T14:30:26.7650109+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": "d1ec527d-eb34-4eb2-8390-f23679f99590",
"yField": "3e5f4df5-e168-4f26-9b8d-e848d90542a4",
"sizeField": "b9fb91f2-fe76-4089-aedf-98ce5479c123"
}
},
{
"Name": "sample string 1",
"Id": "7d752fc8-44df-4855-8cce-e71d9fffe6c5",
"Filters": {},
"UserId": "8c87a93d-ba01-4139-812b-da1875471a53",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "da42a33d-54b1-4dc0-843a-5c4f53f210ad",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-07-11T14:30:26.7650109+00:00",
"EndDateRange": "2025-07-11T14:30:26.7650109+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-07-11T14:30:26.7650109+00:00",
"EndDateRange": "2025-07-11T14:30:26.7650109+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": "d1ec527d-eb34-4eb2-8390-f23679f99590",
"yField": "3e5f4df5-e168-4f26-9b8d-e848d90542a4",
"sizeField": "b9fb91f2-fe76-4089-aedf-98ce5479c123"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "d99c4990-f0fa-47b2-8e83-d9540a142d99",
"TargetData": {
"2025-07-11T14:30:26.7650109+00:00": 2.0
}
},
{
"CostTypeId": "d99c4990-f0fa-47b2-8e83-d9540a142d99",
"TargetData": {
"2025-07-11T14:30:26.7650109+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"73dafbaa-2cfa-45ac-9eea-09891aec33c1",
"7af4ec7b-e315-4dec-a0ba-2231bf43a638"
],
"CascadingLookupField": "cc4dd352-3174-4646-a8de-83586e134ed0",
"CloneOperation": true,
"__app__": "WORKPLANNER",
"__entity_kind__": "WorkPlanner.Models.ModelerModel",
"id": "e5f21996-1d12-400e-b2ec-c16bf7c75ff5",
"RestoreFromId": "00000000-0000-0000-0000-000000000000",
"ConfigId": "df484b08-db3f-476d-9a73-634a2df24eb7",
"_ts": 638878410267650109
}
Response Information
Resource Description
ModelerModel| Name | 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-07-11T14:30:26.7962624+00:00",
"CreatedBy": "f2886c94-a843-42ee-a6f7-838a028a89d2",
"ModifiedDate": "2025-07-11T14:30:26.7962624+00:00",
"ModifiedBy": "3dd436e3-5f2a-41fc-b2fc-01e0595e2e5c",
"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": [
"4126a2da-abd1-4450-afa5-7d65e4a563d2",
"3d5dff75-de5e-4aa6-ac5b-ba13ec9ca216"
],
"UserList": [
{
"UserId": "363467ee-cb35-47c4-be27-0e0578dc09ec",
"Permission": 0,
"Inherited": true
},
{
"UserId": "363467ee-cb35-47c4-be27-0e0578dc09ec",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "363467ee-cb35-47c4-be27-0e0578dc09ec",
"Permission": 0,
"Inherited": true
},
{
"UserId": "363467ee-cb35-47c4-be27-0e0578dc09ec",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "de04aa84-df6e-4193-9c4d-1892036b0c08",
"Views": [
{
"Name": "sample string 1",
"Id": "bcea0592-b126-46fd-9c1f-259cc08cb22d",
"Filters": {},
"UserId": "31c9e334-e5ab-4399-ab5a-e6880b47feb5",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "b820f00f-389b-4075-ba54-fb5a1ab35ea1",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-07-11T14:30:26.7962624+00:00",
"EndDateRange": "2025-07-11T14:30:26.7962624+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-07-11T14:30:26.7962624+00:00",
"EndDateRange": "2025-07-11T14:30:26.7962624+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": "c7e04b08-31ff-43ec-9abb-98a046e03417",
"yField": "60dc8c7f-2641-470b-9991-289991c685c5",
"sizeField": "475d2fc8-43b0-4fc9-aa65-655840bdee9c"
}
},
{
"Name": "sample string 1",
"Id": "bcea0592-b126-46fd-9c1f-259cc08cb22d",
"Filters": {},
"UserId": "31c9e334-e5ab-4399-ab5a-e6880b47feb5",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "b820f00f-389b-4075-ba54-fb5a1ab35ea1",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-07-11T14:30:26.7962624+00:00",
"EndDateRange": "2025-07-11T14:30:26.7962624+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-07-11T14:30:26.7962624+00:00",
"EndDateRange": "2025-07-11T14:30:26.7962624+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": "c7e04b08-31ff-43ec-9abb-98a046e03417",
"yField": "60dc8c7f-2641-470b-9991-289991c685c5",
"sizeField": "475d2fc8-43b0-4fc9-aa65-655840bdee9c"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "4cd3fb0c-d1b3-4129-9a49-3a223c7198a7",
"TargetData": {
"2025-07-11T14:30:26.7962624+00:00": 2.0
}
},
{
"CostTypeId": "4cd3fb0c-d1b3-4129-9a49-3a223c7198a7",
"TargetData": {
"2025-07-11T14:30:26.7962624+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"ea495ad8-09ea-4de2-999c-fc24458c92a4",
"1985c178-1b1f-4cd5-a894-7093882c5108"
],
"CascadingLookupField": "a956b54e-c2cc-46e6-a0da-7cf54e9d75ad",
"CloneOperation": true,
"id": "1fea1ff5-b24c-4628-9595-7eafed8b0a4d",
"ConfigId": "c14d3fcf-0f12-4bb1-8c0b-039cb9f462b5"
}