POST api/workplan
Add a plan
Request Information
URI Parameters
None.
Body Parameters
WorkPlanRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkPlan | WorkPlanReq |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
WorkPlan| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Archived | boolean |
None. |
|
| Author | globally unique identifier |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Editor | globally unique identifier |
None. |
|
| PlannerTypeId | globally unique identifier |
None. |
|
| ParentPlanId | globally unique identifier |
None. |
|
| PortfolioParentId | globally unique identifier |
None. |
|
| PortfolioOrder | integer |
None. |
|
| UserList | Collection of UserAccess |
None. |
|
| InheritUserList | Collection of UserAccess |
None. |
|
| TeamList | Collection of TeamAccess |
None. |
|
| InheritTeamList | Collection of TeamAccess |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| SummaryFields | Dictionary of string [key] and Object [value] |
None. |
|
| Folder | boolean |
None. |
|
| Fragment | boolean |
None. |
|
| FragmentInfo | FragmentInfo |
None. |
|
| Hidden | boolean |
None. |
|
| Comments | Collection of TaskComment |
None. |
|
| LastComment | date |
None. |
|
| Integrations | Collection of IntegratedSystem |
None. |
|
| Snapshots | Collection of FieldSnapshot |
None. |
|
| SubPlans | Collection of globally unique identifier |
None. |
|
| PlanNumber | string |
None. |
|
| RateTables | Collection of PlanRateTable |
None. |
|
| Splits | Collection of LookupSplit |
None. |
|
| LockInfo | PlanLockInfo |
None. |
|
| LastLocation | string |
None. |
|
| StageGateFlow | StageGateFlow |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Archived": true,
"Author": "a5abd923-ccea-411b-8309-ed74e47be2b5",
"Created": "2025-10-19T09:05:08.7364781+00:00",
"Modified": "2025-10-19T09:05:08.7364781+00:00",
"Editor": "5b48765f-68c8-46ee-8e92-91e4c94aa724",
"PlannerTypeId": "3c021519-93b5-46b7-91ff-7f837ad30a2e",
"ParentPlanId": "2ebb2338-9bf8-4823-9b37-b8b8e181c071",
"PortfolioParentId": "f4ef1586-20d4-4aba-841c-2ace1505b364",
"PortfolioOrder": 9,
"UserList": [
{},
{}
],
"InheritUserList": [
{},
{}
],
"TeamList": [
{},
{}
],
"InheritTeamList": [
{},
{}
],
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"SummaryFields": {
"sample string 1": {},
"sample string 3": {}
},
"Folder": true,
"Fragment": true,
"FragmentInfo": {
"Name": "sample string 1",
"Description": "sample string 2",
"Category": "sample string 3",
"WorkTypes": "sample string 4",
"Personal": true
},
"Hidden": true,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
],
"LastComment": "2025-10-19T09:05:08.7364781+00:00",
"Integrations": [
{
"IntegrationId": "454130e5-80b6-49c9-a394-933192b2b6e8",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "31fdac94-f227-41e1-ab5a-a728ea962e44",
"LastExport": "2025-10-19T09:05:08.7364781+00:00",
"LastImport": "2025-10-19T09:05:08.7364781+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "454130e5-80b6-49c9-a394-933192b2b6e8",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "31fdac94-f227-41e1-ab5a-a728ea962e44",
"LastExport": "2025-10-19T09:05:08.7364781+00:00",
"LastImport": "2025-10-19T09:05:08.7364781+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-10-19T09:05:08.7364781+00:00",
"StatusReportId": "cc2846d0-c7ae-4aff-9cea-255f7c349c31",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-10-19T09:05:08.7364781+00:00",
"StatusReportId": "cc2846d0-c7ae-4aff-9cea-255f7c349c31",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"fb02b71c-3e70-47bd-8d27-73488aefdbf6",
"75ff484c-ccd7-4fd4-be8b-a4b6291db310"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "13c9e9a9-4f60-4508-a384-54701fa42c31",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-19T09:05:08.7364781+00:00",
"End": "2025-10-19T09:05:08.7364781+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-19T09:05:08.7364781+00:00",
"End": "2025-10-19T09:05:08.7364781+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "39894b59-0ef7-4c1a-a368-f5fe7afef362",
"BaseRate": 2.0
},
{
"ResourceId": "39894b59-0ef7-4c1a-a368-f5fe7afef362",
"BaseRate": 2.0
}
]
},
{
"Id": "13c9e9a9-4f60-4508-a384-54701fa42c31",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-19T09:05:08.7364781+00:00",
"End": "2025-10-19T09:05:08.7364781+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-19T09:05:08.7364781+00:00",
"End": "2025-10-19T09:05:08.7364781+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "39894b59-0ef7-4c1a-a368-f5fe7afef362",
"BaseRate": 2.0
},
{
"ResourceId": "39894b59-0ef7-4c1a-a368-f5fe7afef362",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "9279f036-79c1-469a-a444-808ad8fcb748",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "9279f036-79c1-469a-a444-808ad8fcb748",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "e280ea4b-65dc-4ade-b05f-f15f48a4fccc",
"LockedBy": "5130f645-fd60-4e55-8ca6-e9eade0fd071",
"LockedDate": "2025-10-19T09:05:08.7364781+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "741f2163-3b64-4fc7-9817-2656d3a11a31",
"CurrentGateId": "cae21b36-1170-4616-a88a-52195606c9a4",
"EnteredGate": "2025-10-19T09:05:08.7364781+00:00",
"ExitedGate": "2025-10-19T09:05:08.7364781+00:00",
"GateClosed": true,
"StepStarter": "33b46be1-fc01-4645-8fe0-2414d2a1f99a",
"StepApprover": "201f4dd3-d715-486e-8acf-3d842ecaae3d",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "fedfaa2d-2835-46dc-95d2-e64ba58f34a8",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"07f75295-7445-4cc7-b707-dfbe86bf84d9": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
},
"b27b0025-ba15-4a43-bfc9-201575da5107": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
}
}
},
{
"StepId": "fedfaa2d-2835-46dc-95d2-e64ba58f34a8",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"07f75295-7445-4cc7-b707-dfbe86bf84d9": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
},
"b27b0025-ba15-4a43-bfc9-201575da5107": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "fedfaa2d-2835-46dc-95d2-e64ba58f34a8",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"07f75295-7445-4cc7-b707-dfbe86bf84d9": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
},
"b27b0025-ba15-4a43-bfc9-201575da5107": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
}
}
},
{
"StepId": "fedfaa2d-2835-46dc-95d2-e64ba58f34a8",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"07f75295-7445-4cc7-b707-dfbe86bf84d9": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
},
"b27b0025-ba15-4a43-bfc9-201575da5107": {
"TaskId": "96975bb7-312f-4e11-b4d4-02f7db065fe2",
"Status": 0,
"Comments": [
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
},
{
"Id": "db4da071-2727-49f1-8e6d-b402dc43c65f",
"UPN": "f8bf944c-013a-44f4-b44a-f0c4b8afdca1",
"PostDate": "2025-10-19T09:05:08.7364781+00:00",
"Comment": "sample string 4",
"CC": [
"0771b2f3-dbd3-4e5f-9399-351e221c14d9",
"5a1dafa4-28b2-4dcf-9c06-5c05a58ede32"
],
"Users": [
"29c41753-50fe-4021-a4c3-7bed7dcc5d52",
"155df80e-5eed-4d5f-800b-bdd17d275192"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "4144d142-a475-409d-b17a-bcdabc138568",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "4144d142-a475-409d-b17a-bcdabc138568",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "ccd8b7a1-28d6-439a-b9a3-224f4b0ba39e",
"ConfigId": "6d9203d3-f098-4273-b09b-7429879fa496"
}