POST api/workplan/{planId}/step/clear
Clear out the stage gates from the plan, cancel all approval tasks and reset the process step back to the first step
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
planId | globally unique identifier |
Required |
Body Parameters
None.
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": "9cf54611-6cc6-49e8-a148-792714ed5153", "Created": "2025-07-11T13:06:28.1836079+00:00", "Modified": "2025-07-11T13:06:28.1836079+00:00", "Editor": "d14aaca7-9bbf-4c3a-929f-dfc86519a810", "PlannerTypeId": "87eadbbd-fddc-4995-b504-33e98f5555c8", "ParentPlanId": "3bee27c6-53b6-4cf0-b3cd-905937b118be", "PortfolioParentId": "f71cd422-0d53-41e0-a490-ff157be558c3", "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": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ], "LastComment": "2025-07-11T13:06:28.1836079+00:00", "Integrations": [ { "IntegrationId": "b2764d8b-b07e-4909-8728-689285cf8c9b", "ItemUrl": "sample string 2", "ItemId": "sample string 3", "TransactionId": "45069a93-e044-4c93-b43c-f65ac52abfd7", "LastExport": "2025-07-11T13:06:28.1836079+00:00", "LastImport": "2025-07-11T13:06:28.1836079+00:00", "IntegrationVersion": 7, "Properties": { "sample string 1": {}, "sample string 3": {} } }, { "IntegrationId": "b2764d8b-b07e-4909-8728-689285cf8c9b", "ItemUrl": "sample string 2", "ItemId": "sample string 3", "TransactionId": "45069a93-e044-4c93-b43c-f65ac52abfd7", "LastExport": "2025-07-11T13:06:28.1836079+00:00", "LastImport": "2025-07-11T13:06:28.1836079+00:00", "IntegrationVersion": 7, "Properties": { "sample string 1": {}, "sample string 3": {} } } ], "Snapshots": [ { "Date": "2025-07-11T13:06:28.1836079+00:00", "StatusReportId": "4dbb4b11-4c12-4321-a388-09622ae468c5", "Fields": { "sample string 1": {}, "sample string 3": {} } }, { "Date": "2025-07-11T13:06:28.1836079+00:00", "StatusReportId": "4dbb4b11-4c12-4321-a388-09622ae468c5", "Fields": { "sample string 1": {}, "sample string 3": {} } } ], "SubPlans": [ "69d97167-563c-40f4-a58e-1a472240c371", "2d432765-8774-4988-888f-a2912743cac9" ], "PlanNumber": "sample string 14", "RateTables": [ { "Id": "cc795f13-0066-4005-a25a-ed2c95582c94", "Name": "sample string 2", "Multipliers": [ { "Start": "2025-07-11T13:06:28.1836079+00:00", "End": "2025-07-11T13:06:28.1836079+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 }, { "Start": "2025-07-11T13:06:28.1836079+00:00", "End": "2025-07-11T13:06:28.1836079+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 } ], "ResourceRates": [ { "ResourceId": "459066a5-b1e0-4eff-a499-33f520edd238", "BaseRate": 2.0 }, { "ResourceId": "459066a5-b1e0-4eff-a499-33f520edd238", "BaseRate": 2.0 } ] }, { "Id": "cc795f13-0066-4005-a25a-ed2c95582c94", "Name": "sample string 2", "Multipliers": [ { "Start": "2025-07-11T13:06:28.1836079+00:00", "End": "2025-07-11T13:06:28.1836079+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 }, { "Start": "2025-07-11T13:06:28.1836079+00:00", "End": "2025-07-11T13:06:28.1836079+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 } ], "ResourceRates": [ { "ResourceId": "459066a5-b1e0-4eff-a499-33f520edd238", "BaseRate": 2.0 }, { "ResourceId": "459066a5-b1e0-4eff-a499-33f520edd238", "BaseRate": 2.0 } ] } ], "Splits": [ { "Field": "sample string 1", "Value": "f5300738-7a65-4a21-bfb3-890c9b732a33", "Split": 3.0, "Values": { "sample string 1": 2.0, "sample string 3": 4.0 } }, { "Field": "sample string 1", "Value": "f5300738-7a65-4a21-bfb3-890c9b732a33", "Split": 3.0, "Values": { "sample string 1": 2.0, "sample string 3": 4.0 } } ], "LockInfo": { "LockedSid": "528ac27b-d31e-421c-9406-a4b5b856f023", "LockedBy": "03c119ca-bafb-4163-b4e0-27be8e6e78cf", "LockedDate": "2025-07-11T13:06:28.1836079+00:00" }, "LastLocation": "sample string 15", "StageGateFlow": { "Id": "0602d345-2947-45b5-8311-0dd2519a2a42", "CurrentGateId": "fc67e766-ab14-4cac-b6ce-659582076b52", "EnteredGate": "2025-07-11T13:06:28.1836079+00:00", "ExitedGate": "2025-07-11T13:06:28.1836079+00:00", "GateClosed": true, "StepStarter": "56b7e1ac-dd63-4e2c-9500-e14ee441bacd", "StepApprover": "8499a333-bdaa-4582-abaf-6dedc987c5bb", "ApprovalState": 0, "StepState": 0, "Comments": "sample string 8", "Approvals": [ { "StepId": "78f7aee6-e4ab-46b0-bbcf-583849943e28", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "0cb9d4df-5718-4535-ace2-c26994d5bfcc": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] }, "24a95cd5-1712-46ae-a603-653e1a74e477": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] } } }, { "StepId": "78f7aee6-e4ab-46b0-bbcf-583849943e28", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "0cb9d4df-5718-4535-ace2-c26994d5bfcc": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] }, "24a95cd5-1712-46ae-a603-653e1a74e477": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] } } } ], "ApprovalsLog": [ { "StepId": "78f7aee6-e4ab-46b0-bbcf-583849943e28", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "0cb9d4df-5718-4535-ace2-c26994d5bfcc": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] }, "24a95cd5-1712-46ae-a603-653e1a74e477": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] } } }, { "StepId": "78f7aee6-e4ab-46b0-bbcf-583849943e28", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "0cb9d4df-5718-4535-ace2-c26994d5bfcc": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] }, "24a95cd5-1712-46ae-a603-653e1a74e477": { "TaskId": "cb4ac4a7-bdde-43a5-ac1c-04c40217295a", "Status": 0, "Comments": [ { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] }, { "Id": "e9b12061-faea-48a0-8571-e16d3dae3e0c", "UPN": "39b5ceea-b5ff-48f0-b77e-b676fd026551", "PostDate": "2025-07-11T13:06:28.1836079+00:00", "Comment": "sample string 4", "CC": [ "59d8371c-e545-4299-8df5-37bc7a224ab2", "addbe6a8-5d76-46e3-bb2c-109c8fb4f16c" ], "Users": [ "02efea1a-238b-46b6-9865-800ece590c47", "cce2ee62-247b-4424-bada-7074e2b8111e" ] } ] } } } ], "RulesRejected": [ { "Id": "7df0ec2e-c1cd-446e-a535-896107086863", "Name": "sample string 2", "FailureText": "sample string 3", "Filter": "sample string 4" }, { "Id": "7df0ec2e-c1cd-446e-a535-896107086863", "Name": "sample string 2", "FailureText": "sample string 3", "Filter": "sample string 4" } ], "ApprovalRejectionOrFailReason": "sample string 9" }, "id": "b456be50-c531-43dd-9577-2621f27b302d", "ConfigId": "a52506e5-be1f-4eac-b3f3-c022c3ecba99" }