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": "dfcecdd0-f86d-44a7-8496-449a73cd23be",
"Created": "2025-07-08T18:18:43.6866006+00:00",
"Modified": "2025-07-08T18:18:43.6866006+00:00",
"Editor": "5877ad8c-8359-4334-9d45-72d5ed4eecb5",
"PlannerTypeId": "6ab609c6-6440-4644-abeb-265dd3ae2244",
"ParentPlanId": "0c85b9b7-8632-4e65-ab03-2332765d0fbc",
"PortfolioParentId": "b7d60000-5ee1-449a-b47f-6438719acb0d",
"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": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
],
"LastComment": "2025-07-08T18:18:43.6866006+00:00",
"Integrations": [
{
"IntegrationId": "4f88586c-5395-4f44-87cc-cc453d089705",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "3de4b633-db08-4bdf-a536-e122da5996f3",
"LastExport": "2025-07-08T18:18:43.6866006+00:00",
"LastImport": "2025-07-08T18:18:43.6866006+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "4f88586c-5395-4f44-87cc-cc453d089705",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "3de4b633-db08-4bdf-a536-e122da5996f3",
"LastExport": "2025-07-08T18:18:43.6866006+00:00",
"LastImport": "2025-07-08T18:18:43.6866006+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-08T18:18:43.6866006+00:00",
"StatusReportId": "d0897516-ee2e-48ca-9277-875b61f5d1e6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-08T18:18:43.6866006+00:00",
"StatusReportId": "d0897516-ee2e-48ca-9277-875b61f5d1e6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"64a47c6f-7f34-446b-bbe7-65d026cec522",
"a48b267b-5eed-4bc8-8d97-316c1565690f"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "32672ade-83f3-4f94-b607-9ac6618d6367",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T18:18:43.6866006+00:00",
"End": "2025-07-08T18:18:43.6866006+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T18:18:43.6866006+00:00",
"End": "2025-07-08T18:18:43.6866006+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "b14207ea-836d-44ad-82c0-970cf3e94803",
"BaseRate": 2.0
},
{
"ResourceId": "b14207ea-836d-44ad-82c0-970cf3e94803",
"BaseRate": 2.0
}
]
},
{
"Id": "32672ade-83f3-4f94-b607-9ac6618d6367",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T18:18:43.6866006+00:00",
"End": "2025-07-08T18:18:43.6866006+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T18:18:43.6866006+00:00",
"End": "2025-07-08T18:18:43.6866006+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "b14207ea-836d-44ad-82c0-970cf3e94803",
"BaseRate": 2.0
},
{
"ResourceId": "b14207ea-836d-44ad-82c0-970cf3e94803",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "d06df3af-fbe0-467d-9e24-aedcdd185cd5",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "d06df3af-fbe0-467d-9e24-aedcdd185cd5",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "74b97278-afe6-43e5-a7cd-31e346abbb98",
"LockedBy": "86635009-4d0f-45b4-b626-a02835657058",
"LockedDate": "2025-07-08T18:18:43.6866006+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "485f25ca-43b2-4f86-b652-e1a0936088ca",
"CurrentGateId": "c764cfd7-bf15-4900-9b9e-d79fb51b4cfd",
"EnteredGate": "2025-07-08T18:18:43.6866006+00:00",
"ExitedGate": "2025-07-08T18:18:43.6866006+00:00",
"GateClosed": true,
"StepStarter": "903070c7-71ab-426c-9d17-dd4fabfb6fab",
"StepApprover": "500a96f0-a50d-4009-a0cb-c5d5cce901ec",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "c4aad621-6722-4622-bbd2-ed1be0b46664",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e0588b61-df3c-4ce6-8e52-3aade36d312b": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
},
"035103d2-b3fb-4d77-9f4b-f18dd12a330a": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
}
}
},
{
"StepId": "c4aad621-6722-4622-bbd2-ed1be0b46664",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e0588b61-df3c-4ce6-8e52-3aade36d312b": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
},
"035103d2-b3fb-4d77-9f4b-f18dd12a330a": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "c4aad621-6722-4622-bbd2-ed1be0b46664",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e0588b61-df3c-4ce6-8e52-3aade36d312b": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
},
"035103d2-b3fb-4d77-9f4b-f18dd12a330a": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
}
}
},
{
"StepId": "c4aad621-6722-4622-bbd2-ed1be0b46664",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e0588b61-df3c-4ce6-8e52-3aade36d312b": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
},
"035103d2-b3fb-4d77-9f4b-f18dd12a330a": {
"TaskId": "d25e6608-4e7d-4e32-a691-d91fb6f9266f",
"Status": 0,
"Comments": [
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
},
{
"Id": "3ed38e7b-1754-41a3-af08-f344e28f19fc",
"UPN": "365085f4-41d7-490a-9ee8-50c0e6d33afe",
"PostDate": "2025-07-08T18:18:43.6866006+00:00",
"Comment": "sample string 4",
"CC": [
"959851df-b961-44a4-bd59-f189393e094c",
"6f4d4fbe-6483-4399-81bf-12f4bcea53d2"
],
"Users": [
"4cad473b-eb75-48fb-a62f-519941d48c26",
"c56319de-dbdb-43c1-aa5b-887fe1fcfdba"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "3edcaca3-2093-4ba4-8ac8-0ab91047f7c6",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "3edcaca3-2093-4ba4-8ac8-0ab91047f7c6",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "4fb8b10b-7599-4c04-82dd-677a512b920a",
"ConfigId": "40d4f07a-1e1d-478f-baaf-a3f4cab473b7"
}