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": "ad1c85b0-a90b-4b28-95ce-365625b984ae",
"Created": "2026-07-01T16:21:29.226379+00:00",
"Modified": "2026-07-01T16:21:29.226379+00:00",
"Editor": "3baa6e29-53fd-4662-b917-f13a295fe9fd",
"PlannerTypeId": "f33992c4-b378-4f2c-90b0-1c524c51a355",
"ParentPlanId": "977e1628-8559-4db3-825a-c8a8c835da10",
"PortfolioParentId": "963aafcf-1281-4540-8a67-48ea43cda1c9",
"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": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
],
"LastComment": "2026-07-01T16:21:29.226379+00:00",
"Integrations": [
{
"IntegrationId": "674cb085-7c25-46e8-bca8-99551d1813cc",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "c9502a09-0310-4500-ad7a-4cfa216d65ee",
"LastExport": "2026-07-01T16:21:29.226379+00:00",
"LastImport": "2026-07-01T16:21:29.226379+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "674cb085-7c25-46e8-bca8-99551d1813cc",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "c9502a09-0310-4500-ad7a-4cfa216d65ee",
"LastExport": "2026-07-01T16:21:29.226379+00:00",
"LastImport": "2026-07-01T16:21:29.226379+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-01T16:21:29.226379+00:00",
"StatusReportId": "a001f3b6-dd1b-4b33-a627-3dd57d29706c",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-01T16:21:29.226379+00:00",
"StatusReportId": "a001f3b6-dd1b-4b33-a627-3dd57d29706c",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"43ed175f-98fc-4b2d-b599-c54203d1a71b",
"106f3a96-355a-48db-adfc-f171ee781b33"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "312b86e3-17d7-4eaa-88f2-df117275088e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:21:29.226379+00:00",
"End": "2026-07-01T16:21:29.226379+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:21:29.226379+00:00",
"End": "2026-07-01T16:21:29.226379+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3f2c262f-2819-4ff3-afd6-00063007a82e",
"BaseRate": 2.0
},
{
"ResourceId": "3f2c262f-2819-4ff3-afd6-00063007a82e",
"BaseRate": 2.0
}
]
},
{
"Id": "312b86e3-17d7-4eaa-88f2-df117275088e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:21:29.226379+00:00",
"End": "2026-07-01T16:21:29.226379+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:21:29.226379+00:00",
"End": "2026-07-01T16:21:29.226379+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "3f2c262f-2819-4ff3-afd6-00063007a82e",
"BaseRate": 2.0
},
{
"ResourceId": "3f2c262f-2819-4ff3-afd6-00063007a82e",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "ff5d158d-7330-438f-9856-d6bc2cb93aac",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "ff5d158d-7330-438f-9856-d6bc2cb93aac",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "33f6d305-4c03-4831-b7c5-11d73ad33972",
"LockedBy": "1046f015-1c37-48a7-b8e2-d68bf800a36b",
"LockedDate": "2026-07-01T16:21:29.226379+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "06060390-b746-4112-a077-6a86c7f83b44",
"CurrentGateId": "18569115-8d95-4459-80a1-b36b0e3b3c80",
"EnteredGate": "2026-07-01T16:21:29.226379+00:00",
"ExitedGate": "2026-07-01T16:21:29.226379+00:00",
"GateClosed": true,
"StepStarter": "41ecebdf-b439-4ae3-b13c-be2e263c7a06",
"StepApprover": "59dcaeb5-0a29-4817-9f9b-72dd08168b68",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "55cdb17e-3eab-456f-97bd-10378a162f03",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e9bc1387-0473-4249-81d8-4c2598c33e11": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
},
"97d0b840-eb56-4468-8d6a-5dcaeb7ea029": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
}
}
},
{
"StepId": "55cdb17e-3eab-456f-97bd-10378a162f03",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e9bc1387-0473-4249-81d8-4c2598c33e11": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
},
"97d0b840-eb56-4468-8d6a-5dcaeb7ea029": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "55cdb17e-3eab-456f-97bd-10378a162f03",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e9bc1387-0473-4249-81d8-4c2598c33e11": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
},
"97d0b840-eb56-4468-8d6a-5dcaeb7ea029": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
}
}
},
{
"StepId": "55cdb17e-3eab-456f-97bd-10378a162f03",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e9bc1387-0473-4249-81d8-4c2598c33e11": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
},
"97d0b840-eb56-4468-8d6a-5dcaeb7ea029": {
"TaskId": "6715e7b0-b113-4f9c-bc36-a6b562fb2d71",
"Status": 0,
"Comments": [
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
},
{
"Id": "3737e183-1901-42e1-9f74-cdc714273bdb",
"UPN": "00e239b4-7c17-4f22-a066-f7c05614f58d",
"PostDate": "2026-07-01T16:21:29.226379+00:00",
"Comment": "sample string 4",
"CC": [
"61d4d84e-a6ba-417b-b1c7-b60892b4f200",
"fa92e9e8-92dd-49f7-8e48-747a319cb9c4"
],
"Users": [
"a3a7da32-73c7-4192-9395-db73e89de3f1",
"5ef623a2-4363-4886-9526-6d960c4ed545"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "132b805a-a991-4105-9dad-45437f094866",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "132b805a-a991-4105-9dad-45437f094866",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "a3543920-b73c-4284-8c92-54828cc28d3c",
"ConfigId": "d7c3be33-bc37-49d5-a4e1-9cc7d454daca"
}