POST api/workplan/{PlanId}/subplans
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PlanId | globally unique identifier |
Required |
Body Parameters
Collection of globally unique identifierRequest Formats
application/json, text/json
Sample:
[ "934678f7-e35b-44ff-8838-ce0617676656", "1c69f4a3-b43b-4dfc-87c1-080e20794ce0" ]
Response Information
Resource Description
WorkPlanName | 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": "f25c342a-220e-4234-980b-82e3ddd3e2e8", "Created": "2025-09-03T18:09:03.0016428+00:00", "Modified": "2025-09-03T18:09:03.0016428+00:00", "Editor": "be78fee7-7dcd-4813-803c-4faffba2e36b", "PlannerTypeId": "bc2946fd-0223-4113-bf0e-d35e73120075", "ParentPlanId": "a2f3ca3c-3274-43df-a3ba-e15fa7a1691c", "PortfolioParentId": "29f24fbc-4ecc-4951-b61b-27df8a94b6af", "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": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ], "LastComment": "2025-09-03T18:09:03.0016428+00:00", "Integrations": [ { "IntegrationId": "15110122-fc62-42ca-b523-f113ebc80f49", "ItemUrl": "sample string 2", "ItemId": "sample string 3", "TransactionId": "5ca9bcc0-2464-4fad-9bf6-45c79f7607cc", "LastExport": "2025-09-03T18:09:03.0016428+00:00", "LastImport": "2025-09-03T18:09:03.0016428+00:00", "IntegrationVersion": 7, "Properties": { "sample string 1": {}, "sample string 3": {} } }, { "IntegrationId": "15110122-fc62-42ca-b523-f113ebc80f49", "ItemUrl": "sample string 2", "ItemId": "sample string 3", "TransactionId": "5ca9bcc0-2464-4fad-9bf6-45c79f7607cc", "LastExport": "2025-09-03T18:09:03.0016428+00:00", "LastImport": "2025-09-03T18:09:03.0016428+00:00", "IntegrationVersion": 7, "Properties": { "sample string 1": {}, "sample string 3": {} } } ], "Snapshots": [ { "Date": "2025-09-03T18:09:03.0016428+00:00", "StatusReportId": "79634386-9cec-451d-b5a0-8ea51c1b4e88", "Fields": { "sample string 1": {}, "sample string 3": {} } }, { "Date": "2025-09-03T18:09:03.0016428+00:00", "StatusReportId": "79634386-9cec-451d-b5a0-8ea51c1b4e88", "Fields": { "sample string 1": {}, "sample string 3": {} } } ], "SubPlans": [ "bca48712-32d6-4fb3-ae45-80d397b93952", "28ad12fe-0a8f-4dde-be88-68cafb4e4f56" ], "PlanNumber": "sample string 14", "RateTables": [ { "Id": "3de008fc-1af3-4676-a03b-c94781f2814d", "Name": "sample string 2", "Multipliers": [ { "Start": "2025-09-03T18:09:03.0016428+00:00", "End": "2025-09-03T18:09:03.0016428+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 }, { "Start": "2025-09-03T18:09:03.0016428+00:00", "End": "2025-09-03T18:09:03.0016428+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 } ], "ResourceRates": [ { "ResourceId": "19f536b5-41d8-46a1-ae15-3304793600e3", "BaseRate": 2.0 }, { "ResourceId": "19f536b5-41d8-46a1-ae15-3304793600e3", "BaseRate": 2.0 } ] }, { "Id": "3de008fc-1af3-4676-a03b-c94781f2814d", "Name": "sample string 2", "Multipliers": [ { "Start": "2025-09-03T18:09:03.0016428+00:00", "End": "2025-09-03T18:09:03.0016428+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 }, { "Start": "2025-09-03T18:09:03.0016428+00:00", "End": "2025-09-03T18:09:03.0016428+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 } ], "ResourceRates": [ { "ResourceId": "19f536b5-41d8-46a1-ae15-3304793600e3", "BaseRate": 2.0 }, { "ResourceId": "19f536b5-41d8-46a1-ae15-3304793600e3", "BaseRate": 2.0 } ] } ], "Splits": [ { "Field": "sample string 1", "Value": "f323a822-2f4f-4f6c-a2cf-2814fecc405d", "Split": 3.0, "Values": { "sample string 1": 2.0, "sample string 3": 4.0 } }, { "Field": "sample string 1", "Value": "f323a822-2f4f-4f6c-a2cf-2814fecc405d", "Split": 3.0, "Values": { "sample string 1": 2.0, "sample string 3": 4.0 } } ], "LockInfo": { "LockedSid": "e8445279-4f27-4b72-9c11-fe53781d0067", "LockedBy": "c487aa72-9fe8-40d2-b1de-eab7a3fbe505", "LockedDate": "2025-09-03T18:09:03.0016428+00:00" }, "LastLocation": "sample string 15", "StageGateFlow": { "Id": "7241c927-6040-4cb8-a8d4-dcdd2e56c8cd", "CurrentGateId": "b69b1b04-907a-4f23-9841-cd9a6d29b96c", "EnteredGate": "2025-09-03T18:09:03.0016428+00:00", "ExitedGate": "2025-09-03T18:09:03.0016428+00:00", "GateClosed": true, "StepStarter": "cc69f700-47dd-42e9-a062-353a6235c164", "StepApprover": "08620470-9d88-4a20-8285-d8785701605d", "ApprovalState": 0, "StepState": 0, "Comments": "sample string 8", "Approvals": [ { "StepId": "518d6791-564e-40c1-88fd-37cf807eae4f", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "eea218f5-e0b4-4c5d-af21-6c12799628f9": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] }, "b4c5e71a-d774-4efe-a29d-a238285af6cc": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] } } }, { "StepId": "518d6791-564e-40c1-88fd-37cf807eae4f", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "eea218f5-e0b4-4c5d-af21-6c12799628f9": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] }, "b4c5e71a-d774-4efe-a29d-a238285af6cc": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] } } } ], "ApprovalsLog": [ { "StepId": "518d6791-564e-40c1-88fd-37cf807eae4f", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "eea218f5-e0b4-4c5d-af21-6c12799628f9": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] }, "b4c5e71a-d774-4efe-a29d-a238285af6cc": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] } } }, { "StepId": "518d6791-564e-40c1-88fd-37cf807eae4f", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "eea218f5-e0b4-4c5d-af21-6c12799628f9": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] }, "b4c5e71a-d774-4efe-a29d-a238285af6cc": { "TaskId": "1b396d9c-4de0-4cc2-b2c2-f0c937f88462", "Status": 0, "Comments": [ { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] }, { "Id": "9312aa73-65c0-40f4-a44f-c3b1f7994181", "UPN": "06199e40-6c98-4315-9032-4ae50cd3f291", "PostDate": "2025-09-03T18:09:03.0016428+00:00", "Comment": "sample string 4", "CC": [ "61d3b224-0a76-498c-b4c4-445ee2f3d959", "b5c3acc9-da10-4d67-9756-51adafb2af37" ], "Users": [ "e416412d-35e2-4c7c-853f-6e9d3cd03126", "02136479-cbfc-40e3-a6c9-294d681ad113" ] } ] } } } ], "RulesRejected": [ { "Id": "258bb719-7724-44ab-89c9-4b3d06b47363", "Name": "sample string 2", "FailureText": "sample string 3", "Filter": "sample string 4" }, { "Id": "258bb719-7724-44ab-89c9-4b3d06b47363", "Name": "sample string 2", "FailureText": "sample string 3", "Filter": "sample string 4" } ], "ApprovalRejectionOrFailReason": "sample string 9" }, "id": "b91d8f2c-f350-49f2-95e5-42e17b4b72b3", "ConfigId": "f7f3dbee-84f6-4a12-9719-584b0ef26b4b" }