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": "eb149ad1-3341-446e-8b10-0b236869b43b",
"Created": "2026-07-01T16:15:47.349982+00:00",
"Modified": "2026-07-01T16:15:47.349982+00:00",
"Editor": "5826b66b-a8a0-456a-8cac-30b1fe7a6043",
"PlannerTypeId": "aa50a4a8-57bf-4bfa-91b8-cee0c262523e",
"ParentPlanId": "11e0d155-0c1e-4ee8-9380-81417b1bc19c",
"PortfolioParentId": "1a22fe9c-1de3-407c-b199-03e533a2a582",
"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": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
],
"LastComment": "2026-07-01T16:15:47.349982+00:00",
"Integrations": [
{
"IntegrationId": "bb97e114-a879-4071-9d4d-d57aab6e1911",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "d06c9df8-4a6a-420d-ba2b-71556c9a1f9c",
"LastExport": "2026-07-01T16:15:47.349982+00:00",
"LastImport": "2026-07-01T16:15:47.349982+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "bb97e114-a879-4071-9d4d-d57aab6e1911",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "d06c9df8-4a6a-420d-ba2b-71556c9a1f9c",
"LastExport": "2026-07-01T16:15:47.349982+00:00",
"LastImport": "2026-07-01T16:15:47.349982+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-01T16:15:47.349982+00:00",
"StatusReportId": "a5e540da-83c2-4624-988f-8b3b667beb55",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-01T16:15:47.349982+00:00",
"StatusReportId": "a5e540da-83c2-4624-988f-8b3b667beb55",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"8ce1c70d-b97f-4a68-aab4-d644b05ded06",
"0cc5dd3c-3644-4e32-9a17-78a89c3f520e"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "94ebd890-3ffd-48ba-aec6-45e0ff37a8f9",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:15:47.349982+00:00",
"End": "2026-07-01T16:15:47.349982+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:15:47.349982+00:00",
"End": "2026-07-01T16:15:47.349982+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "6602268a-0f38-4bed-83f9-ce4eab7e23de",
"BaseRate": 2.0
},
{
"ResourceId": "6602268a-0f38-4bed-83f9-ce4eab7e23de",
"BaseRate": 2.0
}
]
},
{
"Id": "94ebd890-3ffd-48ba-aec6-45e0ff37a8f9",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:15:47.349982+00:00",
"End": "2026-07-01T16:15:47.349982+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:15:47.349982+00:00",
"End": "2026-07-01T16:15:47.349982+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "6602268a-0f38-4bed-83f9-ce4eab7e23de",
"BaseRate": 2.0
},
{
"ResourceId": "6602268a-0f38-4bed-83f9-ce4eab7e23de",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "fb872682-1648-4b7c-b75b-18d8a7e1c829",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "fb872682-1648-4b7c-b75b-18d8a7e1c829",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "1beefe14-b53c-4c5a-b54f-72b2f55b39ba",
"LockedBy": "48cdb00b-d11d-4266-8f06-f089e47cfcff",
"LockedDate": "2026-07-01T16:15:47.349982+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "d294e1d5-bf77-4e95-8581-ca500d0c6005",
"CurrentGateId": "52ab79bb-0431-4337-8e43-973facc23ea4",
"EnteredGate": "2026-07-01T16:15:47.349982+00:00",
"ExitedGate": "2026-07-01T16:15:47.349982+00:00",
"GateClosed": true,
"StepStarter": "0ef1d461-1c15-46bc-89ed-b6d8ccea74c5",
"StepApprover": "b8b16137-9c69-457c-a4db-01bd4f091ffd",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "4461bbe6-ea36-439b-9770-ac6b900436e7",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8c5b6580-e9dc-499e-a4cb-55fdda7b3b68": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
},
"f83111f2-cf35-4733-b29a-073bafe291e1": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
}
}
},
{
"StepId": "4461bbe6-ea36-439b-9770-ac6b900436e7",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8c5b6580-e9dc-499e-a4cb-55fdda7b3b68": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
},
"f83111f2-cf35-4733-b29a-073bafe291e1": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "4461bbe6-ea36-439b-9770-ac6b900436e7",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8c5b6580-e9dc-499e-a4cb-55fdda7b3b68": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
},
"f83111f2-cf35-4733-b29a-073bafe291e1": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
}
}
},
{
"StepId": "4461bbe6-ea36-439b-9770-ac6b900436e7",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8c5b6580-e9dc-499e-a4cb-55fdda7b3b68": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
},
"f83111f2-cf35-4733-b29a-073bafe291e1": {
"TaskId": "1b8dfb6d-5523-4bc7-8b5e-9c253618ae31",
"Status": 0,
"Comments": [
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
},
{
"Id": "184fc01d-dd9e-431f-9b22-b2585af0998c",
"UPN": "6791c42b-667f-4aed-a09a-5706f7cca8f2",
"PostDate": "2026-07-01T16:15:47.349982+00:00",
"Comment": "sample string 4",
"CC": [
"2a52630b-eed4-4612-835b-c2e031a88ca0",
"a66ba7ef-d250-4dd9-9a48-846fa18cf4b5"
],
"Users": [
"25c101e2-5427-484a-b75e-71e73847dcb7",
"51922ad0-e4af-4db4-902e-5f10d9167ab1"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "4de1986c-d9e3-477e-a31b-6fe65bb89549",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "4de1986c-d9e3-477e-a31b-6fe65bb89549",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "15b70a32-99a2-49da-951b-5992c5b92aa5",
"ConfigId": "96faecda-b520-4456-a07b-ebf9b82a2883"
}