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": "4d7726b2-d587-45fd-ae4b-02109395297e",
"Created": "2025-05-23T20:13:08.0912819+00:00",
"Modified": "2025-05-23T20:13:08.0912819+00:00",
"Editor": "40edb95a-0323-4b92-a01b-27aebb84e086",
"PlannerTypeId": "b1f14421-9100-4329-ae3c-a3a3a9b62e45",
"ParentPlanId": "b7e17071-9e81-41eb-9281-9e747035c5e7",
"PortfolioParentId": "feda7ce4-e0c2-4578-be4f-47af08cc804f",
"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": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
],
"LastComment": "2025-05-23T20:13:08.0912819+00:00",
"Integrations": [
{
"IntegrationId": "486e55df-30a9-4ee1-a6a6-bdab66006bdd",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "aaaf35e6-9740-4c72-911e-f171b814730f",
"LastExport": "2025-05-23T20:13:08.0912819+00:00",
"LastImport": "2025-05-23T20:13:08.0912819+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "486e55df-30a9-4ee1-a6a6-bdab66006bdd",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "aaaf35e6-9740-4c72-911e-f171b814730f",
"LastExport": "2025-05-23T20:13:08.0912819+00:00",
"LastImport": "2025-05-23T20:13:08.0912819+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-05-23T20:13:08.0912819+00:00",
"StatusReportId": "a08a8538-23c7-4fde-89bc-f8382cffc153",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-05-23T20:13:08.0912819+00:00",
"StatusReportId": "a08a8538-23c7-4fde-89bc-f8382cffc153",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"55fec0bc-38f0-4310-a7b4-15ebb9c06776",
"ac4c18f3-34d9-46f3-8d67-55f4ec491e12"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "8276a4ce-52b9-4e04-b7be-6091d83a0173",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T20:13:08.0912819+00:00",
"End": "2025-05-23T20:13:08.0912819+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T20:13:08.0912819+00:00",
"End": "2025-05-23T20:13:08.0912819+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "793d7b99-763d-4e91-9075-10519b8fe51f",
"BaseRate": 2.0
},
{
"ResourceId": "793d7b99-763d-4e91-9075-10519b8fe51f",
"BaseRate": 2.0
}
]
},
{
"Id": "8276a4ce-52b9-4e04-b7be-6091d83a0173",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T20:13:08.0912819+00:00",
"End": "2025-05-23T20:13:08.0912819+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T20:13:08.0912819+00:00",
"End": "2025-05-23T20:13:08.0912819+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "793d7b99-763d-4e91-9075-10519b8fe51f",
"BaseRate": 2.0
},
{
"ResourceId": "793d7b99-763d-4e91-9075-10519b8fe51f",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "b4669ecc-ccdc-4b0c-a891-f3673f1153fc",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "b4669ecc-ccdc-4b0c-a891-f3673f1153fc",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "2efb17f5-818d-4fbc-8e11-5b2794703491",
"LockedBy": "fad68fea-2918-4d72-bc1d-b0e5c33b96aa",
"LockedDate": "2025-05-23T20:13:08.0912819+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "7b5bd3d0-af9b-4a70-940d-d1943f1a64d9",
"CurrentGateId": "6417b4a8-c28a-41ba-9ff3-328b37c48157",
"EnteredGate": "2025-05-23T20:13:08.0912819+00:00",
"ExitedGate": "2025-05-23T20:13:08.0912819+00:00",
"GateClosed": true,
"StepStarter": "53078dab-e3bc-4b39-86e7-028b2fe148e4",
"StepApprover": "cede8784-a03a-4a0a-8662-00f343849b1f",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "d2b4b772-e7a2-442b-ae7c-acc164598d30",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"f43f3846-3753-4c0a-8801-46671c96483c": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
},
"4d8745fb-2240-4a73-834c-c60be2748f86": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
}
}
},
{
"StepId": "d2b4b772-e7a2-442b-ae7c-acc164598d30",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"f43f3846-3753-4c0a-8801-46671c96483c": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
},
"4d8745fb-2240-4a73-834c-c60be2748f86": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "d2b4b772-e7a2-442b-ae7c-acc164598d30",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"f43f3846-3753-4c0a-8801-46671c96483c": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
},
"4d8745fb-2240-4a73-834c-c60be2748f86": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
}
}
},
{
"StepId": "d2b4b772-e7a2-442b-ae7c-acc164598d30",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"f43f3846-3753-4c0a-8801-46671c96483c": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
},
"4d8745fb-2240-4a73-834c-c60be2748f86": {
"TaskId": "f25a6051-60cb-4ad7-8030-16efd3201ae5",
"Status": 0,
"Comments": [
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
},
{
"Id": "f515b669-2359-4599-95e9-88e20d1c22b8",
"UPN": "f397a107-f655-485b-a68f-ba496d789951",
"PostDate": "2025-05-23T20:13:08.0912819+00:00",
"Comment": "sample string 4",
"CC": [
"9326b571-2c34-4e06-a5f5-52cf2702f931",
"4773db93-6b23-4430-8bdf-d60f1cd0ea4d"
],
"Users": [
"6aebc77e-3ffe-4731-a50f-d026d65bfa11",
"90542b67-f3ca-463a-96a8-7f610ada0c5a"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "d4b39643-e122-46f1-b66a-4826f49d3609",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "d4b39643-e122-46f1-b66a-4826f49d3609",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "50c119db-7aae-453c-a530-6aa32e10eeb8",
"ConfigId": "83bee2d3-24f4-4215-bfea-9e2fa39a5854"
}