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
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": "2daa1f08-a44b-4304-abb0-f8b3f923eb7a",
"Created": "2026-07-01T16:19:08.1016211+00:00",
"Modified": "2026-07-01T16:19:08.1016211+00:00",
"Editor": "d7e1b7d4-a056-44bd-a1d2-8e7a021d1f6f",
"PlannerTypeId": "229721f5-7079-4303-9afd-aeeabcab6799",
"ParentPlanId": "6264d77c-056c-41b2-8cf7-b538cb577f42",
"PortfolioParentId": "3815f02d-c5c3-4549-8e29-478e13bbc8d7",
"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": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
],
"LastComment": "2026-07-01T16:19:08.1016211+00:00",
"Integrations": [
{
"IntegrationId": "bb3f8d33-e1bb-42ea-b920-8c5644e95afc",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "737428ed-65de-4f15-958b-aa035266ace9",
"LastExport": "2026-07-01T16:19:08.1016211+00:00",
"LastImport": "2026-07-01T16:19:08.1016211+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "bb3f8d33-e1bb-42ea-b920-8c5644e95afc",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "737428ed-65de-4f15-958b-aa035266ace9",
"LastExport": "2026-07-01T16:19:08.1016211+00:00",
"LastImport": "2026-07-01T16:19:08.1016211+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-01T16:19:08.1016211+00:00",
"StatusReportId": "c581c901-b7b7-4138-9893-23978aba8bac",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-01T16:19:08.1016211+00:00",
"StatusReportId": "c581c901-b7b7-4138-9893-23978aba8bac",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"a31766c3-f4ef-4c47-9e3c-8033df7b8edc",
"63760697-4b0d-4244-bcc5-385a22ceac55"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "807afee5-eb60-4bf1-bc06-2dcc49c18138",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:19:08.1016211+00:00",
"End": "2026-07-01T16:19:08.1016211+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:19:08.1016211+00:00",
"End": "2026-07-01T16:19:08.1016211+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3b33283d-1d6f-4b0d-8fee-3f50eb59254b",
"BaseRate": 2.0
},
{
"ResourceId": "3b33283d-1d6f-4b0d-8fee-3f50eb59254b",
"BaseRate": 2.0
}
]
},
{
"Id": "807afee5-eb60-4bf1-bc06-2dcc49c18138",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:19:08.1016211+00:00",
"End": "2026-07-01T16:19:08.1016211+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:19:08.1016211+00:00",
"End": "2026-07-01T16:19:08.1016211+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3b33283d-1d6f-4b0d-8fee-3f50eb59254b",
"BaseRate": 2.0
},
{
"ResourceId": "3b33283d-1d6f-4b0d-8fee-3f50eb59254b",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "b8f1caa6-f6bd-4087-909d-22283bd261bf",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "b8f1caa6-f6bd-4087-909d-22283bd261bf",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "1039c353-2235-4177-b848-ce16a06f9f2c",
"LockedBy": "1dd064ac-08eb-45c5-af21-d41970402078",
"LockedDate": "2026-07-01T16:19:08.1016211+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "97abd079-8c5b-4009-87a4-1683d909042a",
"CurrentGateId": "a9845362-853c-4975-a2dd-32930c4a99ac",
"EnteredGate": "2026-07-01T16:19:08.1016211+00:00",
"ExitedGate": "2026-07-01T16:19:08.1016211+00:00",
"GateClosed": true,
"StepStarter": "209cb06f-5381-4500-9f96-2bca0801a969",
"StepApprover": "c4bc4acf-9257-4e7b-9394-0f242333c2de",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "c6ac07a0-c828-491f-a0d1-aafcee2e1e78",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dbee804-8098-49dc-a044-0f18542d485f": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
},
"39771819-b5aa-4dfd-8abd-2c6e46cb9f09": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
}
}
},
{
"StepId": "c6ac07a0-c828-491f-a0d1-aafcee2e1e78",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dbee804-8098-49dc-a044-0f18542d485f": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
},
"39771819-b5aa-4dfd-8abd-2c6e46cb9f09": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "c6ac07a0-c828-491f-a0d1-aafcee2e1e78",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dbee804-8098-49dc-a044-0f18542d485f": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
},
"39771819-b5aa-4dfd-8abd-2c6e46cb9f09": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
}
}
},
{
"StepId": "c6ac07a0-c828-491f-a0d1-aafcee2e1e78",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dbee804-8098-49dc-a044-0f18542d485f": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
},
"39771819-b5aa-4dfd-8abd-2c6e46cb9f09": {
"TaskId": "1cca1d41-5700-486b-931a-b4e43da5f3e2",
"Status": 0,
"Comments": [
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
},
{
"Id": "f6a50b35-fcac-4cd1-adcf-a6519ac7d41f",
"UPN": "bc841327-6c49-41b7-b77f-a308d6b67780",
"PostDate": "2026-07-01T16:19:08.1016211+00:00",
"Comment": "sample string 4",
"CC": [
"0f910fe6-38b5-487a-ba01-5f9090b87dbb",
"5b704371-6221-4b2c-a55f-7e00cb0da6fa"
],
"Users": [
"72bae921-9db2-4b58-91f9-1ef3948d3040",
"107978fb-fe13-4ea8-82d0-09ace340be54"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5a7afa07-9c87-4e03-9c0e-9fd343a27227",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5a7afa07-9c87-4e03-9c0e-9fd343a27227",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "8a8a1692-37e0-4441-83dc-9af48f662e66",
"ConfigId": "fccddb7a-64d9-49ad-aaf0-97ac0fe97884"
}