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
NameDescriptionTypeAdditional 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-09-03T18:15:20.3427737+00:00",
  "CreatedBy": "134a176a-bca3-4abc-b72f-60969fae72dc",
  "ModifiedDate": "2025-09-03T18:15:20.3427737+00:00",
  "ModifiedBy": "3cbc2d1a-e51d-4265-b996-c4b1036c635f",
  "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": [
    "8c2ef71d-8078-4c8b-af6c-ddd93541bb92",
    "1e3c33eb-4483-43f4-9725-fd865e1ba70a"
  ],
  "UserList": [
    {
      "UserId": "7bc7ee02-0e98-485b-b462-624415972195",
      "Permission": 0,
      "Inherited": true
    },
    {
      "UserId": "7bc7ee02-0e98-485b-b462-624415972195",
      "Permission": 0,
      "Inherited": true
    }
  ],
  "InheritedUserList": [
    {
      "UserId": "7bc7ee02-0e98-485b-b462-624415972195",
      "Permission": 0,
      "Inherited": true
    },
    {
      "UserId": "7bc7ee02-0e98-485b-b462-624415972195",
      "Permission": 0,
      "Inherited": true
    }
  ],
  "ParentId": "1581b400-b2e4-4194-a684-087e4a6e560b",
  "Views": [
    {
      "Name": "sample string 1",
      "Id": "5698fb0d-cde9-4bb0-a633-c5f229a10b6b",
      "Filters": {},
      "UserId": "729a45c8-8b85-44fc-a68c-653232680353",
      "Columns": [
        "sample string 1",
        "sample string 2"
      ],
      "GanttCollapsed": true,
      "Personal": true,
      "PersonalUserId": "d1ee05cf-2106-4fe6-859f-286e7bc43f93",
      "Default": true,
      "resourcePlanSettings": {
        "StartDateRange": "2025-09-03T18:15:20.3427737+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3427737+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-09-03T18:15:20.3427737+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3427737+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": "84c6810f-9df4-43bd-a82d-54ecdf0e0c83",
        "yField": "1cae0a6b-3d09-49e9-a077-7ff87486364d",
        "sizeField": "e33a12b7-0f61-427e-b504-8476bf26e429"
      }
    },
    {
      "Name": "sample string 1",
      "Id": "5698fb0d-cde9-4bb0-a633-c5f229a10b6b",
      "Filters": {},
      "UserId": "729a45c8-8b85-44fc-a68c-653232680353",
      "Columns": [
        "sample string 1",
        "sample string 2"
      ],
      "GanttCollapsed": true,
      "Personal": true,
      "PersonalUserId": "d1ee05cf-2106-4fe6-859f-286e7bc43f93",
      "Default": true,
      "resourcePlanSettings": {
        "StartDateRange": "2025-09-03T18:15:20.3427737+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3427737+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-09-03T18:15:20.3427737+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3427737+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": "84c6810f-9df4-43bd-a82d-54ecdf0e0c83",
        "yField": "1cae0a6b-3d09-49e9-a077-7ff87486364d",
        "sizeField": "e33a12b7-0f61-427e-b504-8476bf26e429"
      }
    }
  ],
  "LastCostPlannerTargets": [
    {
      "CostTypeId": "18c1cb1e-75ad-423d-b5c5-eacfdf45dad4",
      "TargetData": {
        "2025-09-03T18:15:20.3427737+00:00": 2.0
      }
    },
    {
      "CostTypeId": "18c1cb1e-75ad-423d-b5c5-eacfdf45dad4",
      "TargetData": {
        "2025-09-03T18:15:20.3427737+00:00": 2.0
      }
    }
  ],
  "CascadingLookupSelections": [
    "94aee66c-9917-415a-96c9-ede9a9d76b59",
    "be77627f-fd05-40b2-ad6f-8a966794c3ee"
  ],
  "CascadingLookupField": "f12d3216-50f5-4ab8-8df0-ae4ccd275697",
  "CloneOperation": true,
  "__app__": "WORKPLANNER",
  "__entity_kind__": "WorkPlanner.Models.ModelerModel",
  "id": "c2edf7ee-4de1-4099-9a85-81d08154c9a0",
  "RestoreFromId": "00000000-0000-0000-0000-000000000000",
  "ConfigId": "804720a2-d3bf-4495-ab8f-74ec3394c74a",
  "_ts": 638925201203427737
}

Response Information

Resource Description

ModelerModel
NameDescriptionTypeAdditional 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-09-03T18:15:20.3584031+00:00",
  "CreatedBy": "63fbc88f-9ee4-452b-9b9e-0a591d0b2829",
  "ModifiedDate": "2025-09-03T18:15:20.3584031+00:00",
  "ModifiedBy": "3ba1f628-5054-4632-8e1d-5eb3b244f14d",
  "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": [
    "8cd05970-f52b-41c0-891f-2bcc3068e569",
    "5ee4ff71-4097-4503-80d3-39f0f3453109"
  ],
  "UserList": [
    {
      "UserId": "5c5d40df-7378-47c6-977f-87086542d864",
      "Permission": 0,
      "Inherited": true
    },
    {
      "UserId": "5c5d40df-7378-47c6-977f-87086542d864",
      "Permission": 0,
      "Inherited": true
    }
  ],
  "InheritedUserList": [
    {
      "UserId": "5c5d40df-7378-47c6-977f-87086542d864",
      "Permission": 0,
      "Inherited": true
    },
    {
      "UserId": "5c5d40df-7378-47c6-977f-87086542d864",
      "Permission": 0,
      "Inherited": true
    }
  ],
  "ParentId": "f2ed98a5-9392-4c39-85b9-1290e8bdb32a",
  "Views": [
    {
      "Name": "sample string 1",
      "Id": "fff49a46-6e21-43f7-9983-c9303da35662",
      "Filters": {},
      "UserId": "d6c66829-6c53-48f2-937a-06ac1cecd1e8",
      "Columns": [
        "sample string 1",
        "sample string 2"
      ],
      "GanttCollapsed": true,
      "Personal": true,
      "PersonalUserId": "6ca332d3-ff4f-4ca4-b3c4-68ee523d47dd",
      "Default": true,
      "resourcePlanSettings": {
        "StartDateRange": "2025-09-03T18:15:20.3584031+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3584031+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-09-03T18:15:20.3584031+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3584031+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": "cedfb455-73f5-4556-b6af-52dbb64ad374",
        "yField": "e6c3f5f8-ed0d-433f-a82e-c4b2503fb77e",
        "sizeField": "cc75972f-1ad7-42e6-b9d5-e891d97c72a7"
      }
    },
    {
      "Name": "sample string 1",
      "Id": "fff49a46-6e21-43f7-9983-c9303da35662",
      "Filters": {},
      "UserId": "d6c66829-6c53-48f2-937a-06ac1cecd1e8",
      "Columns": [
        "sample string 1",
        "sample string 2"
      ],
      "GanttCollapsed": true,
      "Personal": true,
      "PersonalUserId": "6ca332d3-ff4f-4ca4-b3c4-68ee523d47dd",
      "Default": true,
      "resourcePlanSettings": {
        "StartDateRange": "2025-09-03T18:15:20.3584031+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3584031+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-09-03T18:15:20.3584031+00:00",
        "EndDateRange": "2025-09-03T18:15:20.3584031+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": "cedfb455-73f5-4556-b6af-52dbb64ad374",
        "yField": "e6c3f5f8-ed0d-433f-a82e-c4b2503fb77e",
        "sizeField": "cc75972f-1ad7-42e6-b9d5-e891d97c72a7"
      }
    }
  ],
  "LastCostPlannerTargets": [
    {
      "CostTypeId": "4d442937-6158-479a-ab3e-7f605a7a5dff",
      "TargetData": {
        "2025-09-03T18:15:20.3584031+00:00": 2.0
      }
    },
    {
      "CostTypeId": "4d442937-6158-479a-ab3e-7f605a7a5dff",
      "TargetData": {
        "2025-09-03T18:15:20.3584031+00:00": 2.0
      }
    }
  ],
  "CascadingLookupSelections": [
    "9061a341-bdd9-4755-a37d-f5747822ddb3",
    "32ef133b-eb37-4317-b559-1e0b295593e2"
  ],
  "CascadingLookupField": "4f90f7f4-97c8-4081-9380-38d70d83f512",
  "CloneOperation": true,
  "id": "eedefed5-35ed-493d-bda8-b3383b857da5",
  "ConfigId": "3e2dbf72-3c4d-4d7b-8c07-1be19c33d1d7"
}