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-04-04T02:34:33.4174668+00:00",
"CreatedBy": "1a1d73fc-74c9-40a3-89b2-71f6b8a8815c",
"ModifiedDate": "2025-04-04T02:34:33.4174668+00:00",
"ModifiedBy": "8df2ba03-c241-4ba6-8d30-bd937f808773",
"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": [
"f5689ae3-4352-4b33-a127-fcbefafe651b",
"120084ea-9a95-49d0-90d2-2b09478566b8"
],
"UserList": [
{
"UserId": "6f03a20f-10d7-45ae-ac93-a6ce20377bc9",
"Permission": 0,
"Inherited": true
},
{
"UserId": "6f03a20f-10d7-45ae-ac93-a6ce20377bc9",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "6f03a20f-10d7-45ae-ac93-a6ce20377bc9",
"Permission": 0,
"Inherited": true
},
{
"UserId": "6f03a20f-10d7-45ae-ac93-a6ce20377bc9",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "198ef765-9128-4dc8-be0a-d12baeea1675",
"Views": [
{
"Name": "sample string 1",
"Id": "e7d8b110-0b5f-4265-9114-05bdf96c0ad8",
"Filters": {},
"UserId": "b6ea00fa-88df-4bfd-8998-f4526cd0037f",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "7dafef69-c706-4452-8555-59b315c00f40",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-04-04T02:34:33.4330888+00:00",
"EndDateRange": "2025-04-04T02:34:33.4330888+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:34:33.4330888+00:00",
"EndDateRange": "2025-04-04T02:34:33.4330888+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": "8b17e557-f0b4-4b33-9bf5-d2dc78fcce32",
"yField": "fff48a1c-55d6-475d-a6a1-adc416e5bc8a",
"sizeField": "26f72f20-7e98-4933-bc62-4fc5d001e34a"
}
},
{
"Name": "sample string 1",
"Id": "e7d8b110-0b5f-4265-9114-05bdf96c0ad8",
"Filters": {},
"UserId": "b6ea00fa-88df-4bfd-8998-f4526cd0037f",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "7dafef69-c706-4452-8555-59b315c00f40",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-04-04T02:34:33.4330888+00:00",
"EndDateRange": "2025-04-04T02:34:33.4330888+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:34:33.4330888+00:00",
"EndDateRange": "2025-04-04T02:34:33.4330888+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": "8b17e557-f0b4-4b33-9bf5-d2dc78fcce32",
"yField": "fff48a1c-55d6-475d-a6a1-adc416e5bc8a",
"sizeField": "26f72f20-7e98-4933-bc62-4fc5d001e34a"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "35f531b7-c5fa-42b4-9a8c-23a9e8a49235",
"TargetData": {
"2025-04-04T02:34:33.4330888+00:00": 2.0
}
},
{
"CostTypeId": "35f531b7-c5fa-42b4-9a8c-23a9e8a49235",
"TargetData": {
"2025-04-04T02:34:33.4330888+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"0b3fa420-faea-4e80-9bb6-dc471763e318",
"23a8b92d-4ca4-4ee1-9328-4e9c01752b8d"
],
"CascadingLookupField": "ccffc24e-dd96-48d0-9dda-4386f6913e96",
"CloneOperation": true,
"__app__": "WORKPLANNER",
"__entity_kind__": "WorkPlanner.Models.ModelerModel",
"id": "9ca5c964-d1f4-495f-92a1-4477e565d551",
"RestoreFromId": "00000000-0000-0000-0000-000000000000",
"ConfigId": "9c069b3f-eed0-4891-aecb-882d6465b885",
"_ts": 638793308734174668
}
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-04-04T02:34:33.4799658+00:00",
"CreatedBy": "5322b8dd-94ed-4486-9cda-cc938025fd35",
"ModifiedDate": "2025-04-04T02:34:33.4799658+00:00",
"ModifiedBy": "e3bc155e-e90b-4fae-9496-839002190a5b",
"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": [
"2c98b717-a35a-49cb-9ba3-a711269a299b",
"6b2bb158-2fa2-4dad-8598-6e4ff549d55e"
],
"UserList": [
{
"UserId": "f27a75d2-853c-479f-be3b-3572323b5a81",
"Permission": 0,
"Inherited": true
},
{
"UserId": "f27a75d2-853c-479f-be3b-3572323b5a81",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "f27a75d2-853c-479f-be3b-3572323b5a81",
"Permission": 0,
"Inherited": true
},
{
"UserId": "f27a75d2-853c-479f-be3b-3572323b5a81",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "6a1c8470-e12d-4a65-b91d-c0db66702c21",
"Views": [
{
"Name": "sample string 1",
"Id": "27d9253f-b874-4ee2-91bd-d174f8c2a954",
"Filters": {},
"UserId": "1024013e-e498-46db-a1e3-458849a1603c",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "baa697c3-d3cc-4293-ba41-98eadd76835b",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-04-04T02:34:33.4799658+00:00",
"EndDateRange": "2025-04-04T02:34:33.4799658+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:34:33.4799658+00:00",
"EndDateRange": "2025-04-04T02:34:33.4799658+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": "313052ab-5f51-4b22-87ab-2e70945d56c3",
"yField": "b41c1d76-f2a5-4eb0-8b68-2f7b050fa115",
"sizeField": "fbe7ac10-9358-4b51-8265-295592060c4d"
}
},
{
"Name": "sample string 1",
"Id": "27d9253f-b874-4ee2-91bd-d174f8c2a954",
"Filters": {},
"UserId": "1024013e-e498-46db-a1e3-458849a1603c",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "baa697c3-d3cc-4293-ba41-98eadd76835b",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2025-04-04T02:34:33.4799658+00:00",
"EndDateRange": "2025-04-04T02:34:33.4799658+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:34:33.4799658+00:00",
"EndDateRange": "2025-04-04T02:34:33.4799658+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": "313052ab-5f51-4b22-87ab-2e70945d56c3",
"yField": "b41c1d76-f2a5-4eb0-8b68-2f7b050fa115",
"sizeField": "fbe7ac10-9358-4b51-8265-295592060c4d"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "25d6bdb2-e101-4fec-a9ca-6a5b3fecc099",
"TargetData": {
"2025-04-04T02:34:33.4799658+00:00": 2.0
}
},
{
"CostTypeId": "25d6bdb2-e101-4fec-a9ca-6a5b3fecc099",
"TargetData": {
"2025-04-04T02:34:33.4799658+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"4b4f7e44-baa7-405a-9402-d29968c33df8",
"3b3fb971-3a83-42de-8d8b-bc1e0fe6523f"
],
"CascadingLookupField": "ce4a831a-368c-447f-abbf-d1d10ae983ba",
"CloneOperation": true,
"id": "c4d82796-061b-4bbc-a3ab-872e0c261945",
"ConfigId": "f3b52cb9-01c4-4e94-bc7e-700481abb3b0"
}