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": "23d687d7-fe56-4ba9-b605-c1869726ad44",
"Created": "2025-04-04T02:31:15.0193428+00:00",
"Modified": "2025-04-04T02:31:15.0193428+00:00",
"Editor": "e68570b4-65a0-49cb-8841-ec9fd9aad896",
"PlannerTypeId": "7743aef6-9cf8-4fc3-86ff-b8ce1f9f9089",
"ParentPlanId": "ccab4c18-57e3-44e5-879f-a6ee792c8502",
"PortfolioParentId": "f9af6aae-dd80-4c18-bff7-7d56c914873e",
"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": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
],
"LastComment": "2025-04-04T02:31:15.0193428+00:00",
"Integrations": [
{
"IntegrationId": "e42efa23-1e6e-469f-882d-14f2ba5297fd",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "6f5b7400-9472-4378-adfd-af4faf4fdb07",
"LastExport": "2025-04-04T02:31:15.0349701+00:00",
"LastImport": "2025-04-04T02:31:15.0349701+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "e42efa23-1e6e-469f-882d-14f2ba5297fd",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "6f5b7400-9472-4378-adfd-af4faf4fdb07",
"LastExport": "2025-04-04T02:31:15.0349701+00:00",
"LastImport": "2025-04-04T02:31:15.0349701+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-04-04T02:31:15.0349701+00:00",
"StatusReportId": "97add6b9-bc47-4184-a800-a169342c7992",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-04-04T02:31:15.0349701+00:00",
"StatusReportId": "97add6b9-bc47-4184-a800-a169342c7992",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"e9100242-4403-4d4e-b0b3-e54cbdc34fa5",
"e290a5d8-81a6-4af4-b11f-dab17f7736c8"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "09abda80-ef6f-412b-aef3-a54d4012bbfd",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:31:15.0349701+00:00",
"End": "2025-04-04T02:31:15.0349701+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:31:15.0349701+00:00",
"End": "2025-04-04T02:31:15.0349701+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "cfa1a2b7-131a-48dd-8ae9-447005f1c597",
"BaseRate": 2.0
},
{
"ResourceId": "cfa1a2b7-131a-48dd-8ae9-447005f1c597",
"BaseRate": 2.0
}
]
},
{
"Id": "09abda80-ef6f-412b-aef3-a54d4012bbfd",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:31:15.0349701+00:00",
"End": "2025-04-04T02:31:15.0349701+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:31:15.0349701+00:00",
"End": "2025-04-04T02:31:15.0349701+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "cfa1a2b7-131a-48dd-8ae9-447005f1c597",
"BaseRate": 2.0
},
{
"ResourceId": "cfa1a2b7-131a-48dd-8ae9-447005f1c597",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "c422b9d5-22c3-474c-8e24-a1fd6475a07b",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "c422b9d5-22c3-474c-8e24-a1fd6475a07b",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "969aaf1f-0151-476e-8a95-5355753dad96",
"LockedBy": "df901c2b-7ee1-417d-80e2-12948e01a2da",
"LockedDate": "2025-04-04T02:31:15.0349701+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "22c7ec35-7088-4f65-913b-c3945d5fd2dc",
"CurrentGateId": "23fac025-ebf9-448d-9ec7-27d16beea8ec",
"EnteredGate": "2025-04-04T02:31:15.0349701+00:00",
"ExitedGate": "2025-04-04T02:31:15.0349701+00:00",
"GateClosed": true,
"StepStarter": "c718e096-3eab-49ab-a58b-7572078d597e",
"StepApprover": "61fee91c-54bc-46fb-97d2-de2c0b4f71f9",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "b6723a1f-d95d-433f-b94b-03ec444d149e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"791b55ea-da7e-411b-a054-5242425b27ba": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
},
"a0ebb91f-2d4d-4d03-92f3-f324929fb92b": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
}
}
},
{
"StepId": "b6723a1f-d95d-433f-b94b-03ec444d149e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"791b55ea-da7e-411b-a054-5242425b27ba": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
},
"a0ebb91f-2d4d-4d03-92f3-f324929fb92b": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "b6723a1f-d95d-433f-b94b-03ec444d149e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"791b55ea-da7e-411b-a054-5242425b27ba": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
},
"a0ebb91f-2d4d-4d03-92f3-f324929fb92b": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
}
}
},
{
"StepId": "b6723a1f-d95d-433f-b94b-03ec444d149e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"791b55ea-da7e-411b-a054-5242425b27ba": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
},
"a0ebb91f-2d4d-4d03-92f3-f324929fb92b": {
"TaskId": "b9b099ee-9b05-440c-a924-b67582342b96",
"Status": 0,
"Comments": [
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
},
{
"Id": "adefadd4-bde1-4cf4-a34a-3ba6f6ae45bb",
"UPN": "a910a9a8-9fda-4cbf-88f3-40e26333b033",
"PostDate": "2025-04-04T02:31:15.0193428+00:00",
"Comment": "sample string 4",
"CC": [
"d840e8a1-95bd-45d0-bc95-646c9d7ff37a",
"f910b8f5-bb9a-4dc4-b558-4dcb0f17b24f"
],
"Users": [
"4f89f257-9518-48f0-a86a-d9bbde14dc4f",
"6fcbd5a1-0389-431c-ac23-76efd8c62c54"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5f6bdc45-ec64-48da-807a-2b499225b28f",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5f6bdc45-ec64-48da-807a-2b499225b28f",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "25f356d3-d9a1-4e6e-a45a-c1aed31ebf57",
"ConfigId": "b87db823-3b8e-431f-88f9-2701a18d2f87"
}