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": "d39226bc-f3b3-4eec-8680-ad0f16876cca",
"Created": "2026-06-05T16:25:09.1517316+00:00",
"Modified": "2026-06-05T16:25:09.1517316+00:00",
"Editor": "6a05a258-6a32-4860-8dc7-dcb1c947962a",
"PlannerTypeId": "cd2050a8-b915-45cf-997b-4f7464bcf968",
"ParentPlanId": "e78819ed-7980-4052-899f-acb8329f5a03",
"PortfolioParentId": "6092d6e5-34be-4cb8-b473-7e9a054cbab3",
"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": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
],
"LastComment": "2026-06-05T16:25:09.1517316+00:00",
"Integrations": [
{
"IntegrationId": "128e78e2-87ec-4d12-8632-09a981dd785f",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "496746b8-e855-4943-b806-583e9ff24ddf",
"LastExport": "2026-06-05T16:25:09.1517316+00:00",
"LastImport": "2026-06-05T16:25:09.1517316+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "128e78e2-87ec-4d12-8632-09a981dd785f",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "496746b8-e855-4943-b806-583e9ff24ddf",
"LastExport": "2026-06-05T16:25:09.1517316+00:00",
"LastImport": "2026-06-05T16:25:09.1517316+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-06-05T16:25:09.1517316+00:00",
"StatusReportId": "35c3bb73-9225-442f-9b07-80f67e2c8271",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-06-05T16:25:09.1517316+00:00",
"StatusReportId": "35c3bb73-9225-442f-9b07-80f67e2c8271",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"133cbff5-5f8e-433d-8bf0-4c09b6510fd5",
"c000e35b-ab08-4b50-a602-e6beb3441191"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "bf8dfb0d-4b4e-4fa2-b8fd-b648c1c7c817",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-06-05T16:25:09.1517316+00:00",
"End": "2026-06-05T16:25:09.1517316+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-06-05T16:25:09.1517316+00:00",
"End": "2026-06-05T16:25:09.1517316+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3a16289d-275f-4002-9142-abccdb08e4c5",
"BaseRate": 2.0
},
{
"ResourceId": "3a16289d-275f-4002-9142-abccdb08e4c5",
"BaseRate": 2.0
}
]
},
{
"Id": "bf8dfb0d-4b4e-4fa2-b8fd-b648c1c7c817",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-06-05T16:25:09.1517316+00:00",
"End": "2026-06-05T16:25:09.1517316+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-06-05T16:25:09.1517316+00:00",
"End": "2026-06-05T16:25:09.1517316+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3a16289d-275f-4002-9142-abccdb08e4c5",
"BaseRate": 2.0
},
{
"ResourceId": "3a16289d-275f-4002-9142-abccdb08e4c5",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "14cc1499-403d-4583-93a9-35fdaf0376a1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "14cc1499-403d-4583-93a9-35fdaf0376a1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "a8700ad0-ab68-448a-aa30-ade8319535f1",
"LockedBy": "08eb666d-f371-4cae-a862-f98cf2a2138f",
"LockedDate": "2026-06-05T16:25:09.1517316+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "17b84c0b-fe3e-4f3c-afc2-835fbd4c575e",
"CurrentGateId": "4976f74b-4921-4c1f-ade3-e9d2dd9ed3be",
"EnteredGate": "2026-06-05T16:25:09.1517316+00:00",
"ExitedGate": "2026-06-05T16:25:09.1517316+00:00",
"GateClosed": true,
"StepStarter": "a45e32a7-82ac-491a-9c05-b5e3a2142368",
"StepApprover": "9207dac8-0875-473a-a0ab-6fd442f483e7",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "b65a09ae-b26d-47cf-b991-fa2c126fa772",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"da6e2704-ea9c-40c5-9d4a-d14fcd280a26": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
},
"4c2ee923-a950-4079-8f07-c86cf2fc6b6e": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
}
}
},
{
"StepId": "b65a09ae-b26d-47cf-b991-fa2c126fa772",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"da6e2704-ea9c-40c5-9d4a-d14fcd280a26": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
},
"4c2ee923-a950-4079-8f07-c86cf2fc6b6e": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "b65a09ae-b26d-47cf-b991-fa2c126fa772",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"da6e2704-ea9c-40c5-9d4a-d14fcd280a26": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
},
"4c2ee923-a950-4079-8f07-c86cf2fc6b6e": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
}
}
},
{
"StepId": "b65a09ae-b26d-47cf-b991-fa2c126fa772",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"da6e2704-ea9c-40c5-9d4a-d14fcd280a26": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
},
"4c2ee923-a950-4079-8f07-c86cf2fc6b6e": {
"TaskId": "b4c2b180-81ab-4811-983e-e99802650132",
"Status": 0,
"Comments": [
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
},
{
"Id": "2fc9530f-35ab-4f02-a705-6ea6e0a1d696",
"UPN": "5b37d93c-9f58-4dbe-b090-af090f2f3d8c",
"PostDate": "2026-06-05T16:25:09.1517316+00:00",
"Comment": "sample string 4",
"CC": [
"aa1cc85e-c796-4558-82d2-c720b329a503",
"2f27f7ba-2ace-4ece-908b-b3cf77127e5f"
],
"Users": [
"9cf6b943-c054-4252-951a-46682737a254",
"b71ffe97-c23c-480d-9f93-e2461fbb9247"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "969d6e33-53be-408f-9b9c-6a9043b95f83",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "969d6e33-53be-408f-9b9c-6a9043b95f83",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "c5b01b60-1333-4e40-a063-178d86bacae9",
"ConfigId": "a621c5c2-f897-40a5-a0ee-7d1722658d71"
}