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. |
|
| IsPrivate | boolean |
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": "3cca4e6e-d7c6-4c96-98b3-00e09f0a6cf9",
"Created": "2026-09-29T19:17:52.1693348+00:00",
"Modified": "2026-09-29T19:17:52.1693348+00:00",
"Editor": "4b7aa845-4947-4aa0-ae19-7a3f0bee6cd8",
"PlannerTypeId": "c4aaea98-8d48-4b7a-90e6-6c1f592ad275",
"ParentPlanId": "44a4e525-2942-44ea-ad5e-3ef0ed3afc93",
"PortfolioParentId": "368031a1-8f8e-464e-b0c4-34f4a23666f8",
"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": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
],
"LastComment": "2026-09-29T19:17:52.1693348+00:00",
"Integrations": [
{
"IntegrationId": "21b6925d-0be1-4f77-930b-d7c04deadb04",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "5c8c5e66-29a3-44d7-8c44-3f7057b4dce6",
"LastExport": "2026-09-29T19:17:52.1693348+00:00",
"LastImport": "2026-09-29T19:17:52.1693348+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "21b6925d-0be1-4f77-930b-d7c04deadb04",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "5c8c5e66-29a3-44d7-8c44-3f7057b4dce6",
"LastExport": "2026-09-29T19:17:52.1693348+00:00",
"LastImport": "2026-09-29T19:17:52.1693348+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-09-29T19:17:52.1693348+00:00",
"StatusReportId": "b0928c23-619e-4249-9212-c545b57f81b1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-09-29T19:17:52.1693348+00:00",
"StatusReportId": "b0928c23-619e-4249-9212-c545b57f81b1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"0bdfbbe1-a587-42da-995f-85a43a75da82",
"f2f616e2-2097-4936-b2a1-b0e2dbd7c6af"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "201f33ab-4f38-41d5-a1c8-409a2b68cfee",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:17:52.1693348+00:00",
"End": "2026-09-29T19:17:52.1693348+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:17:52.1693348+00:00",
"End": "2026-09-29T19:17:52.1693348+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e0c7e25c-e8ab-49b7-a1a9-c202f4ad9bfa",
"BaseRate": 2.0
},
{
"ResourceId": "e0c7e25c-e8ab-49b7-a1a9-c202f4ad9bfa",
"BaseRate": 2.0
}
]
},
{
"Id": "201f33ab-4f38-41d5-a1c8-409a2b68cfee",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:17:52.1693348+00:00",
"End": "2026-09-29T19:17:52.1693348+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:17:52.1693348+00:00",
"End": "2026-09-29T19:17:52.1693348+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e0c7e25c-e8ab-49b7-a1a9-c202f4ad9bfa",
"BaseRate": 2.0
},
{
"ResourceId": "e0c7e25c-e8ab-49b7-a1a9-c202f4ad9bfa",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "ebf1f486-c831-41de-90c2-315ec2830171",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "ebf1f486-c831-41de-90c2-315ec2830171",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "9df22059-9ec7-47b9-b655-ef3cdaa8c02e",
"LockedBy": "3f2fec16-1088-495b-92c6-b8ac6de302ee",
"LockedDate": "2026-09-29T19:17:52.1693348+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "345f0362-63ce-4f2a-9e06-f395f6b09cf7",
"CurrentGateId": "e0d744e4-e19b-403d-9040-282379e001a5",
"EnteredGate": "2026-09-29T19:17:52.1693348+00:00",
"ExitedGate": "2026-09-29T19:17:52.1693348+00:00",
"GateClosed": true,
"StepStarter": "574d4f16-ccce-471f-a7c2-c1c3b330a82f",
"StepApprover": "e3ab1726-fc48-4259-a313-1c50f6980c50",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "39749fec-bd1c-468b-a403-bdce205de8db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"9ebe3057-b174-4496-9d70-5f05dd085c12": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
},
"d884c465-fbd8-409b-81a1-fad1c70d1a6f": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
}
}
},
{
"StepId": "39749fec-bd1c-468b-a403-bdce205de8db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"9ebe3057-b174-4496-9d70-5f05dd085c12": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
},
"d884c465-fbd8-409b-81a1-fad1c70d1a6f": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "39749fec-bd1c-468b-a403-bdce205de8db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"9ebe3057-b174-4496-9d70-5f05dd085c12": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
},
"d884c465-fbd8-409b-81a1-fad1c70d1a6f": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
}
}
},
{
"StepId": "39749fec-bd1c-468b-a403-bdce205de8db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"9ebe3057-b174-4496-9d70-5f05dd085c12": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
},
"d884c465-fbd8-409b-81a1-fad1c70d1a6f": {
"TaskId": "f82ad423-46a2-4527-aa98-7498139e608b",
"Status": 0,
"Comments": [
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
},
{
"Id": "829fd8b7-9c1e-41ee-9604-15ff1970e0c2",
"UPN": "bbba0b61-f46b-4ae4-8221-a4429190d12e",
"PostDate": "2026-09-29T19:17:52.1693348+00:00",
"Comment": "sample string 4",
"CC": [
"cf5d39db-5efe-413b-a436-3c2a20fbb90d",
"4dae5ad7-d6f4-4c20-906b-c0154833868f"
],
"Users": [
"c87ac9e0-19df-48a7-bcf1-8aa44081cf51",
"79bb7606-c82b-4c93-bc2e-5d2e660320a5"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "cdea206a-8961-4b7f-9b7d-9e9204209dae",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "cdea206a-8961-4b7f-9b7d-9e9204209dae",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"IsPrivate": true,
"id": "2298f0b0-c4aa-4c18-abeb-0c9a90d3faab",
"ConfigId": "1fb09202-71d7-400a-9c4b-9ca2cbca9b01"
}