POST api/workplan/{PlanId}/stagegates/start?StepName={StepName}&StepId={StepId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PlanId | globally unique identifier |
Required |
|
StepName | string |
Default value is |
|
StepId | globally unique identifier |
None. |
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": "865f55e4-7947-4130-9159-643703131dfc", "Created": "2025-07-08T20:09:15.9222122+00:00", "Modified": "2025-07-08T20:09:15.9222122+00:00", "Editor": "fe1c78b4-ffdd-499d-b629-646c95e6ae2b", "PlannerTypeId": "6d844816-fca6-45bd-87b2-92690af712cf", "ParentPlanId": "1e7486ab-bc55-4fd5-8f90-20b8c498e9df", "PortfolioParentId": "6a0566d6-60f3-4e5a-abaa-d5cb189a3700", "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": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ], "LastComment": "2025-07-08T20:09:15.9222122+00:00", "Integrations": [ { "IntegrationId": "79d65108-46b7-4c07-b344-a19053ad4fd0", "ItemUrl": "sample string 2", "ItemId": "sample string 3", "TransactionId": "153547e0-8347-4584-bc13-20d343e337b4", "LastExport": "2025-07-08T20:09:15.9222122+00:00", "LastImport": "2025-07-08T20:09:15.9222122+00:00", "IntegrationVersion": 7, "Properties": { "sample string 1": {}, "sample string 3": {} } }, { "IntegrationId": "79d65108-46b7-4c07-b344-a19053ad4fd0", "ItemUrl": "sample string 2", "ItemId": "sample string 3", "TransactionId": "153547e0-8347-4584-bc13-20d343e337b4", "LastExport": "2025-07-08T20:09:15.9222122+00:00", "LastImport": "2025-07-08T20:09:15.9222122+00:00", "IntegrationVersion": 7, "Properties": { "sample string 1": {}, "sample string 3": {} } } ], "Snapshots": [ { "Date": "2025-07-08T20:09:15.9222122+00:00", "StatusReportId": "67ca7dc5-806d-425e-b9db-24ac8d36e9d7", "Fields": { "sample string 1": {}, "sample string 3": {} } }, { "Date": "2025-07-08T20:09:15.9222122+00:00", "StatusReportId": "67ca7dc5-806d-425e-b9db-24ac8d36e9d7", "Fields": { "sample string 1": {}, "sample string 3": {} } } ], "SubPlans": [ "e3ceeb40-b48d-49dd-921a-6f26221581aa", "699c89db-c66f-47b4-8aa5-5426c9b7f9de" ], "PlanNumber": "sample string 14", "RateTables": [ { "Id": "cf7a6757-10dd-4945-af8b-cd2de997356e", "Name": "sample string 2", "Multipliers": [ { "Start": "2025-07-08T20:09:15.9222122+00:00", "End": "2025-07-08T20:09:15.9222122+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 }, { "Start": "2025-07-08T20:09:15.9222122+00:00", "End": "2025-07-08T20:09:15.9222122+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 } ], "ResourceRates": [ { "ResourceId": "3719f4ec-91e1-4630-84db-d728823edba3", "BaseRate": 2.0 }, { "ResourceId": "3719f4ec-91e1-4630-84db-d728823edba3", "BaseRate": 2.0 } ] }, { "Id": "cf7a6757-10dd-4945-af8b-cd2de997356e", "Name": "sample string 2", "Multipliers": [ { "Start": "2025-07-08T20:09:15.9222122+00:00", "End": "2025-07-08T20:09:15.9222122+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 }, { "Start": "2025-07-08T20:09:15.9222122+00:00", "End": "2025-07-08T20:09:15.9222122+00:00", "PercentRevenue": 3.0, "PercentCost": 4.0 } ], "ResourceRates": [ { "ResourceId": "3719f4ec-91e1-4630-84db-d728823edba3", "BaseRate": 2.0 }, { "ResourceId": "3719f4ec-91e1-4630-84db-d728823edba3", "BaseRate": 2.0 } ] } ], "Splits": [ { "Field": "sample string 1", "Value": "2551021c-7562-4fe4-9290-ba7b894c88e4", "Split": 3.0, "Values": { "sample string 1": 2.0, "sample string 3": 4.0 } }, { "Field": "sample string 1", "Value": "2551021c-7562-4fe4-9290-ba7b894c88e4", "Split": 3.0, "Values": { "sample string 1": 2.0, "sample string 3": 4.0 } } ], "LockInfo": { "LockedSid": "91b3056f-b601-42f6-80be-8a2e8854a812", "LockedBy": "df9128e3-431d-4a4b-994c-6a081e4f2246", "LockedDate": "2025-07-08T20:09:15.9222122+00:00" }, "LastLocation": "sample string 15", "StageGateFlow": { "Id": "df39533d-c628-4319-b12e-dbf9b8ffebc1", "CurrentGateId": "9a6fb245-2c13-4557-90bf-94e324c97d0d", "EnteredGate": "2025-07-08T20:09:15.9222122+00:00", "ExitedGate": "2025-07-08T20:09:15.9222122+00:00", "GateClosed": true, "StepStarter": "2f569f32-8703-4661-8024-cb137a33dbee", "StepApprover": "55e44925-b189-405b-8381-3bd3f2b36ae3", "ApprovalState": 0, "StepState": 0, "Comments": "sample string 8", "Approvals": [ { "StepId": "f238d553-0d0f-49b7-985a-fd61a1c7ca95", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "75b9c28b-5996-4014-94dd-2c7ac9aef1b0": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] }, "535acd89-fb30-44c4-b00a-f3e85264b2fc": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] } } }, { "StepId": "f238d553-0d0f-49b7-985a-fd61a1c7ca95", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "75b9c28b-5996-4014-94dd-2c7ac9aef1b0": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] }, "535acd89-fb30-44c4-b00a-f3e85264b2fc": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] } } } ], "ApprovalsLog": [ { "StepId": "f238d553-0d0f-49b7-985a-fd61a1c7ca95", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "75b9c28b-5996-4014-94dd-2c7ac9aef1b0": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] }, "535acd89-fb30-44c4-b00a-f3e85264b2fc": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] } } }, { "StepId": "f238d553-0d0f-49b7-985a-fd61a1c7ca95", "AutoApproved": true, "Completed": true, "Expired": true, "ExpiredReason": "sample string 5", "ApprovalStates": { "75b9c28b-5996-4014-94dd-2c7ac9aef1b0": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] }, "535acd89-fb30-44c4-b00a-f3e85264b2fc": { "TaskId": "692f3108-1698-494b-9e27-8b859ecdb1d7", "Status": 0, "Comments": [ { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] }, { "Id": "b6c492e5-cf72-4e24-aedb-64a19114409b", "UPN": "d9350754-4249-48d7-a2c6-6ff583e8c86d", "PostDate": "2025-07-08T20:09:15.9222122+00:00", "Comment": "sample string 4", "CC": [ "5bd06061-1ad9-469a-867a-81f4b7f91d55", "5500fe99-7e08-462b-9739-de78ad1c8037" ], "Users": [ "b7c5fd86-188d-48d7-a26e-16177ad84b63", "59793dab-e9f7-4bd6-ad08-4947fa6c2419" ] } ] } } } ], "RulesRejected": [ { "Id": "c3940929-67d9-4aed-9ae8-aefd1b100267", "Name": "sample string 2", "FailureText": "sample string 3", "Filter": "sample string 4" }, { "Id": "c3940929-67d9-4aed-9ae8-aefd1b100267", "Name": "sample string 2", "FailureText": "sample string 3", "Filter": "sample string 4" } ], "ApprovalRejectionOrFailReason": "sample string 9" }, "id": "e5c658cd-6f0b-448c-ab9b-89478ad5ab33", "ConfigId": "c8866c8a-75f1-4f3e-b2ac-1fb7129d62ae" }