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": "0520080a-fcca-444f-917a-30731dd3ed9f",
"Created": "2025-07-16T12:58:20.3929972+00:00",
"Modified": "2025-07-16T12:58:20.3929972+00:00",
"Editor": "93a5705c-bd9d-4c64-8f5d-e1e8d608c074",
"PlannerTypeId": "f59fd911-7c0e-4a10-9874-5bfd0f5f8ad2",
"ParentPlanId": "9eddae35-c804-4a21-978d-24e3d8203316",
"PortfolioParentId": "4d270eab-42e8-4bc0-8882-e8d49448699a",
"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": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
],
"LastComment": "2025-07-16T12:58:20.3929972+00:00",
"Integrations": [
{
"IntegrationId": "71e3e448-aeab-48df-80e9-7af048db1fb3",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "cb1547ea-d62e-43e4-907c-3f2db3dcdffd",
"LastExport": "2025-07-16T12:58:20.3929972+00:00",
"LastImport": "2025-07-16T12:58:20.3929972+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "71e3e448-aeab-48df-80e9-7af048db1fb3",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "cb1547ea-d62e-43e4-907c-3f2db3dcdffd",
"LastExport": "2025-07-16T12:58:20.3929972+00:00",
"LastImport": "2025-07-16T12:58:20.3929972+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-16T12:58:20.3929972+00:00",
"StatusReportId": "1c752c1b-425b-411d-82c0-5caf13b245ce",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-16T12:58:20.3929972+00:00",
"StatusReportId": "1c752c1b-425b-411d-82c0-5caf13b245ce",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"b931af33-1da7-4b7e-97f8-eef6135de45a",
"16192e08-5279-4aed-9c9c-d2bba56736a6"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "5113bf42-2f96-4dde-9abb-9bb96ecdb5a8",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-16T12:58:20.3929972+00:00",
"End": "2025-07-16T12:58:20.3929972+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-16T12:58:20.3929972+00:00",
"End": "2025-07-16T12:58:20.3929972+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "f19ddd7a-f533-4ebc-9bdb-a1fcf8d24a9f",
"BaseRate": 2.0
},
{
"ResourceId": "f19ddd7a-f533-4ebc-9bdb-a1fcf8d24a9f",
"BaseRate": 2.0
}
]
},
{
"Id": "5113bf42-2f96-4dde-9abb-9bb96ecdb5a8",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-16T12:58:20.3929972+00:00",
"End": "2025-07-16T12:58:20.3929972+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-16T12:58:20.3929972+00:00",
"End": "2025-07-16T12:58:20.3929972+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "f19ddd7a-f533-4ebc-9bdb-a1fcf8d24a9f",
"BaseRate": 2.0
},
{
"ResourceId": "f19ddd7a-f533-4ebc-9bdb-a1fcf8d24a9f",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "e2cae829-3c8c-40f2-93c4-14facece36ce",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "e2cae829-3c8c-40f2-93c4-14facece36ce",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "8075a2fe-0dfb-4fbe-9c40-a9f9c0a4e8e9",
"LockedBy": "61ab5d91-8e94-4c3b-aa6f-172420ee62a8",
"LockedDate": "2025-07-16T12:58:20.3929972+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "fcf93cb0-5730-43ae-957f-bcc69e5ff321",
"CurrentGateId": "19515ba7-7a60-488e-a786-8b8f88c610a9",
"EnteredGate": "2025-07-16T12:58:20.3929972+00:00",
"ExitedGate": "2025-07-16T12:58:20.3929972+00:00",
"GateClosed": true,
"StepStarter": "30dbc495-31da-443c-99fa-c9804686485d",
"StepApprover": "331772f5-385a-4721-99bd-111baf7c5bac",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "45198805-04ba-4526-9426-ad7583b5c598",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1268e3c1-bd61-4035-9e42-83c1af03de7f": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
},
"87a5fee9-4ae4-49ac-bc12-1ae8b83a0eec": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
}
}
},
{
"StepId": "45198805-04ba-4526-9426-ad7583b5c598",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1268e3c1-bd61-4035-9e42-83c1af03de7f": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
},
"87a5fee9-4ae4-49ac-bc12-1ae8b83a0eec": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "45198805-04ba-4526-9426-ad7583b5c598",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1268e3c1-bd61-4035-9e42-83c1af03de7f": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
},
"87a5fee9-4ae4-49ac-bc12-1ae8b83a0eec": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
}
}
},
{
"StepId": "45198805-04ba-4526-9426-ad7583b5c598",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1268e3c1-bd61-4035-9e42-83c1af03de7f": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
},
"87a5fee9-4ae4-49ac-bc12-1ae8b83a0eec": {
"TaskId": "78d56169-781a-4042-9bb6-2c9ab9d35e88",
"Status": 0,
"Comments": [
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
},
{
"Id": "ab292137-619f-4815-8b75-1596a9a92f4a",
"UPN": "3eb4d0f1-f02f-4f6d-b9d6-4a51979af862",
"PostDate": "2025-07-16T12:58:20.3929972+00:00",
"Comment": "sample string 4",
"CC": [
"cfe0071d-b666-43a6-b90b-2b267b1fa759",
"cfdb5c1d-3b2e-486b-b4e4-a396e27a66cb"
],
"Users": [
"af846a7d-497c-486e-aedd-cb16f7d36415",
"0e001206-7e2f-46e0-a8c0-f26f67934c57"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "d5747716-8b5e-4f90-9adf-429fd98c1e1e",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "d5747716-8b5e-4f90-9adf-429fd98c1e1e",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "404d4517-8683-4642-92df-50dfdebe0d7b",
"ConfigId": "1830e070-1cdb-4fdd-8a32-f96fd5b0431f"
}