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": "2024-12-13T16:30:27.1138699+00:00",
"CreatedBy": "9e46a89d-2620-45fb-93ac-e236b8d16800",
"ModifiedDate": "2024-12-13T16:30:27.1138699+00:00",
"ModifiedBy": "cf7f80db-c0ab-49ed-ba42-dcb8f7e6a912",
"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": [
"af24f25c-3278-414d-95d1-c21dfa5457a9",
"db29c9fd-6783-4999-9ee0-4f234fc1bf5d"
],
"UserList": [
{
"UserId": "f30ff7c0-945a-44c3-87fe-0df3448fffc8",
"Permission": 0,
"Inherited": true
},
{
"UserId": "f30ff7c0-945a-44c3-87fe-0df3448fffc8",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "f30ff7c0-945a-44c3-87fe-0df3448fffc8",
"Permission": 0,
"Inherited": true
},
{
"UserId": "f30ff7c0-945a-44c3-87fe-0df3448fffc8",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "48a7b985-110d-4645-a3ad-0f257525600d",
"Views": [
{
"Name": "sample string 1",
"Id": "3bec9ce9-5ba2-479c-85e6-2be4c946c02f",
"Filters": {},
"UserId": "5a731799-a2ef-468e-a364-afd4e02ade8f",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "0dee73ff-8402-4e14-9c3b-34ac1e68e0f5",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2024-12-13T16:30:27.1138699+00:00",
"EndDateRange": "2024-12-13T16:30:27.1138699+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": "2024-12-13T16:30:27.1138699+00:00",
"EndDateRange": "2024-12-13T16:30:27.1138699+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": "1c9cde6d-cfab-4107-858e-ef4f47f3f575",
"yField": "1908f233-cacb-4d43-901f-41b563ce7529",
"sizeField": "85c340e9-b072-412e-bf8c-89a7146a0ee6"
}
},
{
"Name": "sample string 1",
"Id": "3bec9ce9-5ba2-479c-85e6-2be4c946c02f",
"Filters": {},
"UserId": "5a731799-a2ef-468e-a364-afd4e02ade8f",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "0dee73ff-8402-4e14-9c3b-34ac1e68e0f5",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2024-12-13T16:30:27.1138699+00:00",
"EndDateRange": "2024-12-13T16:30:27.1138699+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": "2024-12-13T16:30:27.1138699+00:00",
"EndDateRange": "2024-12-13T16:30:27.1138699+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": "1c9cde6d-cfab-4107-858e-ef4f47f3f575",
"yField": "1908f233-cacb-4d43-901f-41b563ce7529",
"sizeField": "85c340e9-b072-412e-bf8c-89a7146a0ee6"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "28ec1d28-bd05-410d-ae28-88effac20ab1",
"TargetData": {
"2024-12-13T16:30:27.1138699+00:00": 2.0
}
},
{
"CostTypeId": "28ec1d28-bd05-410d-ae28-88effac20ab1",
"TargetData": {
"2024-12-13T16:30:27.1138699+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"e3f24ff2-372a-4687-9ebd-3280291e8a9b",
"5308fb31-d146-42ae-b6c1-29f2465697a5"
],
"CascadingLookupField": "57da265d-984e-49e7-a418-a9b5d2598ffd",
"CloneOperation": true,
"__app__": "WORKPLANNER",
"__entity_kind__": "WorkPlanner.Models.ModelerModel",
"id": "9ec482c6-cba3-4c45-b64c-0c5f0a147c76",
"RestoreFromId": "00000000-0000-0000-0000-000000000000",
"ConfigId": "07b170e8-d7f2-4fbe-bd14-c99df617aa25",
"_ts": 638697042271138699
}
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": "2024-12-13T16:30:27.1451222+00:00",
"CreatedBy": "b20bc6fa-b294-4c10-9144-a99fe6a8fc45",
"ModifiedDate": "2024-12-13T16:30:27.1451222+00:00",
"ModifiedBy": "f484b652-3b5e-45c0-ab7b-8cc1bb78faf6",
"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": [
"c91da69e-9e6a-43a3-ac13-f481f42f14bd",
"9070b533-25b7-440c-bd8a-90f390cf2e68"
],
"UserList": [
{
"UserId": "9e089179-830d-404d-8ddb-6f9a5202e86c",
"Permission": 0,
"Inherited": true
},
{
"UserId": "9e089179-830d-404d-8ddb-6f9a5202e86c",
"Permission": 0,
"Inherited": true
}
],
"InheritedUserList": [
{
"UserId": "9e089179-830d-404d-8ddb-6f9a5202e86c",
"Permission": 0,
"Inherited": true
},
{
"UserId": "9e089179-830d-404d-8ddb-6f9a5202e86c",
"Permission": 0,
"Inherited": true
}
],
"ParentId": "474fa666-a93c-42ef-b6c7-03e6dab7d8cd",
"Views": [
{
"Name": "sample string 1",
"Id": "7be01b4e-b744-475a-8dc8-437ed5cfef18",
"Filters": {},
"UserId": "fb7c9c82-c606-43ac-ab9a-e0c22a72ca41",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "440f7131-cb04-4178-9716-83437fcee163",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2024-12-13T16:30:27.1451222+00:00",
"EndDateRange": "2024-12-13T16:30:27.1451222+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": "2024-12-13T16:30:27.1451222+00:00",
"EndDateRange": "2024-12-13T16:30:27.1451222+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": "93478110-5da0-4809-a668-a889ac97de12",
"yField": "8047ae05-c9dc-459f-a5c5-a13dc6f36f91",
"sizeField": "1669ed82-e833-442e-b877-4ea8d329a54d"
}
},
{
"Name": "sample string 1",
"Id": "7be01b4e-b744-475a-8dc8-437ed5cfef18",
"Filters": {},
"UserId": "fb7c9c82-c606-43ac-ab9a-e0c22a72ca41",
"Columns": [
"sample string 1",
"sample string 2"
],
"GanttCollapsed": true,
"Personal": true,
"PersonalUserId": "440f7131-cb04-4178-9716-83437fcee163",
"Default": true,
"resourcePlanSettings": {
"StartDateRange": "2024-12-13T16:30:27.1451222+00:00",
"EndDateRange": "2024-12-13T16:30:27.1451222+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": "2024-12-13T16:30:27.1451222+00:00",
"EndDateRange": "2024-12-13T16:30:27.1451222+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": "93478110-5da0-4809-a668-a889ac97de12",
"yField": "8047ae05-c9dc-459f-a5c5-a13dc6f36f91",
"sizeField": "1669ed82-e833-442e-b877-4ea8d329a54d"
}
}
],
"LastCostPlannerTargets": [
{
"CostTypeId": "3af719f8-5f18-42e5-9500-73ef4de2c130",
"TargetData": {
"2024-12-13T16:30:27.1451222+00:00": 2.0
}
},
{
"CostTypeId": "3af719f8-5f18-42e5-9500-73ef4de2c130",
"TargetData": {
"2024-12-13T16:30:27.1451222+00:00": 2.0
}
}
],
"CascadingLookupSelections": [
"72546e86-9fad-478a-a971-7c4ec35af3b1",
"2a503fb1-3989-454e-be5d-9dd88620b090"
],
"CascadingLookupField": "daaceb4a-708b-417b-b104-cb4c0e066289",
"CloneOperation": true,
"id": "d5ff4d09-2607-46fd-99d1-ee1d46ff9bb0",
"ConfigId": "1724a225-105d-4f94-a254-dd929c8115da"
}