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
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": "54862798-aaa3-48c6-9530-f4b00a4529fc",
"Created": "2025-05-23T22:09:15.934478+00:00",
"Modified": "2025-05-23T22:09:15.934478+00:00",
"Editor": "609460f7-6492-4a52-a28c-01d9898a0a09",
"PlannerTypeId": "1250ef3a-7dfd-4a09-a595-09000bd34c0b",
"ParentPlanId": "80862fa3-ca97-47ee-8a0e-acbb1c2024ef",
"PortfolioParentId": "52ad9141-663c-43ae-a782-a2ea9435e69e",
"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": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
],
"LastComment": "2025-05-23T22:09:15.934478+00:00",
"Integrations": [
{
"IntegrationId": "e2b99a44-43e7-40bd-9764-5a8d533bbd3d",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1bf0378e-70c3-4ccf-bbd6-fb4a695961a6",
"LastExport": "2025-05-23T22:09:15.934478+00:00",
"LastImport": "2025-05-23T22:09:15.934478+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "e2b99a44-43e7-40bd-9764-5a8d533bbd3d",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1bf0378e-70c3-4ccf-bbd6-fb4a695961a6",
"LastExport": "2025-05-23T22:09:15.934478+00:00",
"LastImport": "2025-05-23T22:09:15.934478+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-05-23T22:09:15.934478+00:00",
"StatusReportId": "a3c06acd-511d-4d2a-bc95-51c5555fe8d6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-05-23T22:09:15.934478+00:00",
"StatusReportId": "a3c06acd-511d-4d2a-bc95-51c5555fe8d6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"b43a81e7-470e-4c54-8aa7-120ae79ae95f",
"b00941ab-6243-4861-b2b7-b5e2be6a30df"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "fb86d118-50dd-43b0-9fd9-c0d05023d0af",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T22:09:15.934478+00:00",
"End": "2025-05-23T22:09:15.934478+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T22:09:15.934478+00:00",
"End": "2025-05-23T22:09:15.934478+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3279c191-e40f-46c1-af3e-60d6017b024a",
"BaseRate": 2.0
},
{
"ResourceId": "3279c191-e40f-46c1-af3e-60d6017b024a",
"BaseRate": 2.0
}
]
},
{
"Id": "fb86d118-50dd-43b0-9fd9-c0d05023d0af",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T22:09:15.934478+00:00",
"End": "2025-05-23T22:09:15.934478+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T22:09:15.934478+00:00",
"End": "2025-05-23T22:09:15.934478+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3279c191-e40f-46c1-af3e-60d6017b024a",
"BaseRate": 2.0
},
{
"ResourceId": "3279c191-e40f-46c1-af3e-60d6017b024a",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "6baf09e1-90cf-43a7-85cc-123ce528faf7",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "6baf09e1-90cf-43a7-85cc-123ce528faf7",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "1dc9d014-544f-47b3-805d-49a8efd6d3bd",
"LockedBy": "47817b2b-f8a4-4601-b2cf-bcdc91b5c9ca",
"LockedDate": "2025-05-23T22:09:15.934478+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "2e79fcf6-2dd3-43ab-96ee-7314d8ce5448",
"CurrentGateId": "daabe3ae-1d80-4938-88d4-20db6ea01d01",
"EnteredGate": "2025-05-23T22:09:15.934478+00:00",
"ExitedGate": "2025-05-23T22:09:15.934478+00:00",
"GateClosed": true,
"StepStarter": "41c14636-d3f8-43e7-9b5c-d90db8fa1b84",
"StepApprover": "f3bf59bd-531c-4546-a37f-0bfb1d90eeda",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "6480e463-aadb-44fe-88c3-b4ad39de26a6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"30ee09ef-2e97-45e5-9edb-e9bb676ee8b1": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
},
"bc1153b1-9ef9-4b56-97ba-82aaf3f51995": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
}
}
},
{
"StepId": "6480e463-aadb-44fe-88c3-b4ad39de26a6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"30ee09ef-2e97-45e5-9edb-e9bb676ee8b1": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
},
"bc1153b1-9ef9-4b56-97ba-82aaf3f51995": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "6480e463-aadb-44fe-88c3-b4ad39de26a6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"30ee09ef-2e97-45e5-9edb-e9bb676ee8b1": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
},
"bc1153b1-9ef9-4b56-97ba-82aaf3f51995": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
}
}
},
{
"StepId": "6480e463-aadb-44fe-88c3-b4ad39de26a6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"30ee09ef-2e97-45e5-9edb-e9bb676ee8b1": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
},
"bc1153b1-9ef9-4b56-97ba-82aaf3f51995": {
"TaskId": "9f94a4a8-8378-4918-9f32-bbe2cb4cd626",
"Status": 0,
"Comments": [
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
},
{
"Id": "b682748b-867c-4c93-9c1a-6d548adbd67d",
"UPN": "38d7072d-1a4b-450f-92c6-3b58ec71d0d1",
"PostDate": "2025-05-23T22:09:15.934478+00:00",
"Comment": "sample string 4",
"CC": [
"3e09bfad-1747-4d7d-ae39-0d4c928641e4",
"b9679b91-238f-4230-b1f0-8aa8565de041"
],
"Users": [
"69a6c3e5-28f3-4d02-bf2a-7daeb50c1b4d",
"a3d8164f-0e38-4d93-9f4e-65f57822f485"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5bd820f7-5c67-4597-b72b-c5bb3500deaa",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5bd820f7-5c67-4597-b72b-c5bb3500deaa",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "019e8689-b3ea-4d04-8727-d06abc8eb7c1",
"ConfigId": "0d550731-3b4b-443e-a010-b49421937e58"
}