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": "91aac40a-73fb-4264-beab-aaa69f083343",
"Created": "2026-04-30T17:19:20.7768876+00:00",
"Modified": "2026-04-30T17:19:20.7768876+00:00",
"Editor": "e3a80874-6c84-430d-a510-48e7a9d822c4",
"PlannerTypeId": "2daa45c2-1a4f-42d0-980c-3dbd09960f55",
"ParentPlanId": "ff5ab741-08ad-452d-94ac-0d9e99ca2106",
"PortfolioParentId": "05070f2a-e92a-4d32-9f4e-9e864dce6617",
"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": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
],
"LastComment": "2026-04-30T17:19:20.7768876+00:00",
"Integrations": [
{
"IntegrationId": "15ff652f-a7ec-4a58-b804-2847237bd734",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "34135673-0632-41c8-a801-a052e236be6e",
"LastExport": "2026-04-30T17:19:20.7768876+00:00",
"LastImport": "2026-04-30T17:19:20.7768876+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "15ff652f-a7ec-4a58-b804-2847237bd734",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "34135673-0632-41c8-a801-a052e236be6e",
"LastExport": "2026-04-30T17:19:20.7768876+00:00",
"LastImport": "2026-04-30T17:19:20.7768876+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-04-30T17:19:20.7768876+00:00",
"StatusReportId": "7eb13634-6e08-4f10-8325-4d92e8844962",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-04-30T17:19:20.7768876+00:00",
"StatusReportId": "7eb13634-6e08-4f10-8325-4d92e8844962",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"71e900db-05c9-43c6-8a06-595ef59eba44",
"3b2f72ae-5685-4a5c-acaf-089bec27ee8c"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "87892275-596c-45b0-a7f7-ecac2b223f2e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-04-30T17:19:20.7768876+00:00",
"End": "2026-04-30T17:19:20.7768876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-04-30T17:19:20.7768876+00:00",
"End": "2026-04-30T17:19:20.7768876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "72e6b0df-4988-445f-9bdd-799603d013bb",
"BaseRate": 2.0
},
{
"ResourceId": "72e6b0df-4988-445f-9bdd-799603d013bb",
"BaseRate": 2.0
}
]
},
{
"Id": "87892275-596c-45b0-a7f7-ecac2b223f2e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-04-30T17:19:20.7768876+00:00",
"End": "2026-04-30T17:19:20.7768876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-04-30T17:19:20.7768876+00:00",
"End": "2026-04-30T17:19:20.7768876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "72e6b0df-4988-445f-9bdd-799603d013bb",
"BaseRate": 2.0
},
{
"ResourceId": "72e6b0df-4988-445f-9bdd-799603d013bb",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "60120e6c-5b0a-4010-a079-d4c074333fc2",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "60120e6c-5b0a-4010-a079-d4c074333fc2",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "7eae3d1d-3e8e-4f96-8db5-0336d66418fc",
"LockedBy": "7267e71d-6787-4e4c-98f1-bbd070cffaac",
"LockedDate": "2026-04-30T17:19:20.7768876+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "2077c0d9-80a4-4ac3-813b-ad30d6927ce9",
"CurrentGateId": "579fc52a-1039-4d10-b1a4-35619a725feb",
"EnteredGate": "2026-04-30T17:19:20.7768876+00:00",
"ExitedGate": "2026-04-30T17:19:20.7768876+00:00",
"GateClosed": true,
"StepStarter": "b230d8ed-7c51-4213-9e25-4cb7b2badddf",
"StepApprover": "7db821bb-86c8-42fa-8306-18076b1e2dac",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "6806c33d-4afe-439e-bc40-b4cbd2acbb76",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"0059cada-a7c0-4652-b0e8-c470ba57f334": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
},
"c0507f1d-379d-4f60-b98e-9704ba7ee47b": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
}
}
},
{
"StepId": "6806c33d-4afe-439e-bc40-b4cbd2acbb76",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"0059cada-a7c0-4652-b0e8-c470ba57f334": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
},
"c0507f1d-379d-4f60-b98e-9704ba7ee47b": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "6806c33d-4afe-439e-bc40-b4cbd2acbb76",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"0059cada-a7c0-4652-b0e8-c470ba57f334": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
},
"c0507f1d-379d-4f60-b98e-9704ba7ee47b": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
}
}
},
{
"StepId": "6806c33d-4afe-439e-bc40-b4cbd2acbb76",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"0059cada-a7c0-4652-b0e8-c470ba57f334": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
},
"c0507f1d-379d-4f60-b98e-9704ba7ee47b": {
"TaskId": "6799f803-28d2-4677-b3aa-03bad05882f9",
"Status": 0,
"Comments": [
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
},
{
"Id": "4579f855-ba55-4429-b617-b3ee395acaac",
"UPN": "3de352b6-b6b2-4647-a176-37dd3bf512ae",
"PostDate": "2026-04-30T17:19:20.7768876+00:00",
"Comment": "sample string 4",
"CC": [
"0b9f7d2e-0c22-470d-a94d-4e5df38b24a5",
"9bbcb83f-85c7-4333-807e-6cf9a8df7137"
],
"Users": [
"c11f3cc4-4a79-4b61-9cf9-f5633f7426c7",
"a76c1ddc-3dac-4b50-825a-cb99da7d9212"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "039a4233-d0f4-468a-abcb-ee1e7c4060e5",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "039a4233-d0f4-468a-abcb-ee1e7c4060e5",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "7e253557-c9f8-49b6-ac89-f7f3fcfa906f",
"ConfigId": "fd6ac568-26ab-4676-b080-a4c4faf45f24"
}