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	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": "459a33b4-11e4-4007-b92f-bca2de1cd126",
  "Created": "2025-09-04T03:09:23.3604881+00:00",
  "Modified": "2025-09-04T03:09:23.3604881+00:00",
  "Editor": "d67e6940-e8c6-47e6-a563-69d83bbb10b5",
  "PlannerTypeId": "c2a2fdac-ef94-4587-b363-fe0648eddcdf",
  "ParentPlanId": "d4c9b56f-6677-4b6d-9546-ea94a8844cfd",
  "PortfolioParentId": "42c8196d-5b46-4c93-846e-7b676c6847df",
  "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": "9bacca88-868d-4555-a93a-6eb3d32940d9",
      "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
      "PostDate": "2025-09-04T03:09:23.3604881+00:00",
      "Comment": "sample string 4",
      "CC": [
        "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
        "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
      ],
      "Users": [
        "7d222429-058f-4da8-ad99-dd5ce8647a70",
        "7fecacba-0da9-484d-89c4-761e68d53660"
      ]
    },
    {
      "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
      "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
      "PostDate": "2025-09-04T03:09:23.3604881+00:00",
      "Comment": "sample string 4",
      "CC": [
        "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
        "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
      ],
      "Users": [
        "7d222429-058f-4da8-ad99-dd5ce8647a70",
        "7fecacba-0da9-484d-89c4-761e68d53660"
      ]
    }
  ],
  "LastComment": "2025-09-04T03:09:23.3604881+00:00",
  "Integrations": [
    {
      "IntegrationId": "347c307f-d7e0-4f86-b336-05bbc344c936",
      "ItemUrl": "sample string 2",
      "ItemId": "sample string 3",
      "TransactionId": "59c18866-1439-4aa0-8a62-164a3a937a8e",
      "LastExport": "2025-09-04T03:09:23.3604881+00:00",
      "LastImport": "2025-09-04T03:09:23.3604881+00:00",
      "IntegrationVersion": 7,
      "Properties": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "IntegrationId": "347c307f-d7e0-4f86-b336-05bbc344c936",
      "ItemUrl": "sample string 2",
      "ItemId": "sample string 3",
      "TransactionId": "59c18866-1439-4aa0-8a62-164a3a937a8e",
      "LastExport": "2025-09-04T03:09:23.3604881+00:00",
      "LastImport": "2025-09-04T03:09:23.3604881+00:00",
      "IntegrationVersion": 7,
      "Properties": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "Snapshots": [
    {
      "Date": "2025-09-04T03:09:23.3604881+00:00",
      "StatusReportId": "2f0722e9-2acf-4bbb-ad84-0eb980c4bb88",
      "Fields": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "Date": "2025-09-04T03:09:23.3604881+00:00",
      "StatusReportId": "2f0722e9-2acf-4bbb-ad84-0eb980c4bb88",
      "Fields": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "SubPlans": [
    "296d58ec-df61-43de-9662-67dfad3fbc72",
    "a7253703-aecc-489f-8238-045d8867202d"
  ],
  "PlanNumber": "sample string 14",
  "RateTables": [
    {
      "Id": "aaea22f6-c064-40c3-82c2-4661e9837dbc",
      "Name": "sample string 2",
      "Multipliers": [
        {
          "Start": "2025-09-04T03:09:23.3604881+00:00",
          "End": "2025-09-04T03:09:23.3604881+00:00",
          "PercentRevenue": 3.0,
          "PercentCost": 4.0
        },
        {
          "Start": "2025-09-04T03:09:23.3604881+00:00",
          "End": "2025-09-04T03:09:23.3604881+00:00",
          "PercentRevenue": 3.0,
          "PercentCost": 4.0
        }
      ],
      "ResourceRates": [
        {
          "ResourceId": "c1123c6b-d9d6-43e6-8f74-6c2fef012598",
          "BaseRate": 2.0
        },
        {
          "ResourceId": "c1123c6b-d9d6-43e6-8f74-6c2fef012598",
          "BaseRate": 2.0
        }
      ]
    },
    {
      "Id": "aaea22f6-c064-40c3-82c2-4661e9837dbc",
      "Name": "sample string 2",
      "Multipliers": [
        {
          "Start": "2025-09-04T03:09:23.3604881+00:00",
          "End": "2025-09-04T03:09:23.3604881+00:00",
          "PercentRevenue": 3.0,
          "PercentCost": 4.0
        },
        {
          "Start": "2025-09-04T03:09:23.3604881+00:00",
          "End": "2025-09-04T03:09:23.3604881+00:00",
          "PercentRevenue": 3.0,
          "PercentCost": 4.0
        }
      ],
      "ResourceRates": [
        {
          "ResourceId": "c1123c6b-d9d6-43e6-8f74-6c2fef012598",
          "BaseRate": 2.0
        },
        {
          "ResourceId": "c1123c6b-d9d6-43e6-8f74-6c2fef012598",
          "BaseRate": 2.0
        }
      ]
    }
  ],
  "Splits": [
    {
      "Field": "sample string 1",
      "Value": "7e6d41d0-fe69-4cba-9014-26e9422da65b",
      "Split": 3.0,
      "Values": {
        "sample string 1": 2.0,
        "sample string 3": 4.0
      }
    },
    {
      "Field": "sample string 1",
      "Value": "7e6d41d0-fe69-4cba-9014-26e9422da65b",
      "Split": 3.0,
      "Values": {
        "sample string 1": 2.0,
        "sample string 3": 4.0
      }
    }
  ],
  "LockInfo": {
    "LockedSid": "d8c99c49-7cdd-4b86-8a19-cf68f3ae40b4",
    "LockedBy": "2b784515-9fc6-411f-8ad5-b2a097ffae79",
    "LockedDate": "2025-09-04T03:09:23.3604881+00:00"
  },
  "LastLocation": "sample string 15",
  "StageGateFlow": {
    "Id": "f1b58e97-5636-4bad-9801-5af335289115",
    "CurrentGateId": "676374b1-66f9-41bc-8410-7c14c915dbcb",
    "EnteredGate": "2025-09-04T03:09:23.3604881+00:00",
    "ExitedGate": "2025-09-04T03:09:23.3604881+00:00",
    "GateClosed": true,
    "StepStarter": "274284f1-9da2-4ba5-8b8e-60bc2244ca2f",
    "StepApprover": "4940da5e-6d8f-4817-953b-5e3a140f5670",
    "ApprovalState": 0,
    "StepState": 0,
    "Comments": "sample string 8",
    "Approvals": [
      {
        "StepId": "c96876e0-d7f6-4a08-aaf3-8a7dffe0f03d",
        "AutoApproved": true,
        "Completed": true,
        "Expired": true,
        "ExpiredReason": "sample string 5",
        "ApprovalStates": {
          "d90005d4-4223-45fd-aaef-9dcc2f1bf905": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          },
          "f140367f-f11f-4b28-9122-332d1b4a5cfe": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          }
        }
      },
      {
        "StepId": "c96876e0-d7f6-4a08-aaf3-8a7dffe0f03d",
        "AutoApproved": true,
        "Completed": true,
        "Expired": true,
        "ExpiredReason": "sample string 5",
        "ApprovalStates": {
          "d90005d4-4223-45fd-aaef-9dcc2f1bf905": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          },
          "f140367f-f11f-4b28-9122-332d1b4a5cfe": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          }
        }
      }
    ],
    "ApprovalsLog": [
      {
        "StepId": "c96876e0-d7f6-4a08-aaf3-8a7dffe0f03d",
        "AutoApproved": true,
        "Completed": true,
        "Expired": true,
        "ExpiredReason": "sample string 5",
        "ApprovalStates": {
          "d90005d4-4223-45fd-aaef-9dcc2f1bf905": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          },
          "f140367f-f11f-4b28-9122-332d1b4a5cfe": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          }
        }
      },
      {
        "StepId": "c96876e0-d7f6-4a08-aaf3-8a7dffe0f03d",
        "AutoApproved": true,
        "Completed": true,
        "Expired": true,
        "ExpiredReason": "sample string 5",
        "ApprovalStates": {
          "d90005d4-4223-45fd-aaef-9dcc2f1bf905": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          },
          "f140367f-f11f-4b28-9122-332d1b4a5cfe": {
            "TaskId": "3a851a76-38c6-4bce-8126-278f07bbc3e9",
            "Status": 0,
            "Comments": [
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              },
              {
                "Id": "9bacca88-868d-4555-a93a-6eb3d32940d9",
                "UPN": "51904b1a-0d1d-480f-bbfc-f762b3192b86",
                "PostDate": "2025-09-04T03:09:23.3604881+00:00",
                "Comment": "sample string 4",
                "CC": [
                  "05cc35d8-2e6a-42bf-92c0-1ce16316859b",
                  "2bfca9c2-6779-4eaf-a624-66b7b84bf63f"
                ],
                "Users": [
                  "7d222429-058f-4da8-ad99-dd5ce8647a70",
                  "7fecacba-0da9-484d-89c4-761e68d53660"
                ]
              }
            ]
          }
        }
      }
    ],
    "RulesRejected": [
      {
        "Id": "685bd87b-1dd7-4d35-b48a-01c8c9ec9ea3",
        "Name": "sample string 2",
        "FailureText": "sample string 3",
        "Filter": "sample string 4"
      },
      {
        "Id": "685bd87b-1dd7-4d35-b48a-01c8c9ec9ea3",
        "Name": "sample string 2",
        "FailureText": "sample string 3",
        "Filter": "sample string 4"
      }
    ],
    "ApprovalRejectionOrFailReason": "sample string 9"
  },
  "id": "79fb0a63-8e91-47e4-bc14-d8e88a75371a",
  "ConfigId": "563d035e-41a9-4ad9-8c88-019c17f24458"
}