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": "580ffd17-a654-4df5-a8e4-de998aaaaca6",
"Created": "2025-12-02T15:47:37.4915553+00:00",
"Modified": "2025-12-02T15:47:37.4915553+00:00",
"Editor": "21478919-b535-4d15-a2c5-665df6abfc70",
"PlannerTypeId": "f24b4c42-b09e-4a55-a656-55805471c1fc",
"ParentPlanId": "104fb3b0-18fa-456f-ac58-21a00e9fbda2",
"PortfolioParentId": "6d965263-303b-4b69-9304-277a76cdbed6",
"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": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
],
"LastComment": "2025-12-02T15:47:37.4915553+00:00",
"Integrations": [
{
"IntegrationId": "02bcc5f7-803a-4e5e-a419-13059ab8ab6c",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "112a83e1-9cbd-45a3-aa75-77cdf6a7daf6",
"LastExport": "2025-12-02T15:47:37.4915553+00:00",
"LastImport": "2025-12-02T15:47:37.4915553+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "02bcc5f7-803a-4e5e-a419-13059ab8ab6c",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "112a83e1-9cbd-45a3-aa75-77cdf6a7daf6",
"LastExport": "2025-12-02T15:47:37.4915553+00:00",
"LastImport": "2025-12-02T15:47:37.4915553+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-12-02T15:47:37.4915553+00:00",
"StatusReportId": "36dc1753-2207-4847-854c-9a84703335a3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-12-02T15:47:37.4915553+00:00",
"StatusReportId": "36dc1753-2207-4847-854c-9a84703335a3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"2dac8ba3-2309-4b3e-9fac-5a84eb1bc61b",
"e99784a1-1681-4c59-a63a-9742a817f3dc"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "e3c47b49-50f1-4107-9e4f-fc090cbf35d3",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-12-02T15:47:37.4915553+00:00",
"End": "2025-12-02T15:47:37.4915553+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-12-02T15:47:37.4915553+00:00",
"End": "2025-12-02T15:47:37.4915553+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "ba0123d1-2413-407f-9b5d-205bf70ada72",
"BaseRate": 2.0
},
{
"ResourceId": "ba0123d1-2413-407f-9b5d-205bf70ada72",
"BaseRate": 2.0
}
]
},
{
"Id": "e3c47b49-50f1-4107-9e4f-fc090cbf35d3",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-12-02T15:47:37.4915553+00:00",
"End": "2025-12-02T15:47:37.4915553+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-12-02T15:47:37.4915553+00:00",
"End": "2025-12-02T15:47:37.4915553+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "ba0123d1-2413-407f-9b5d-205bf70ada72",
"BaseRate": 2.0
},
{
"ResourceId": "ba0123d1-2413-407f-9b5d-205bf70ada72",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "326dde30-a1db-459c-92df-4ffce029cd82",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "326dde30-a1db-459c-92df-4ffce029cd82",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "93daabe8-55c9-4dda-bf25-f690a8dd1e86",
"LockedBy": "057f32b6-b2ad-440a-a0e4-68640bfa14ba",
"LockedDate": "2025-12-02T15:47:37.4915553+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "ae8dcf15-3ff8-4959-a2d9-2b60363fb681",
"CurrentGateId": "d3aaf027-13cd-4674-b050-080deccf29b3",
"EnteredGate": "2025-12-02T15:47:37.4915553+00:00",
"ExitedGate": "2025-12-02T15:47:37.4915553+00:00",
"GateClosed": true,
"StepStarter": "78896478-1491-4e4d-a13f-1d6a8c92d703",
"StepApprover": "b2ca4ede-f1fc-49ad-a7a9-52961d583592",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "04a1a735-bde5-45c1-a307-7a32d66a73be",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c7a3956f-3325-4c93-a5bd-2527f1320112": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
},
"42cc58eb-f1f7-46d0-bfe3-ab97c7c6182d": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
}
}
},
{
"StepId": "04a1a735-bde5-45c1-a307-7a32d66a73be",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c7a3956f-3325-4c93-a5bd-2527f1320112": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
},
"42cc58eb-f1f7-46d0-bfe3-ab97c7c6182d": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "04a1a735-bde5-45c1-a307-7a32d66a73be",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c7a3956f-3325-4c93-a5bd-2527f1320112": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
},
"42cc58eb-f1f7-46d0-bfe3-ab97c7c6182d": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
}
}
},
{
"StepId": "04a1a735-bde5-45c1-a307-7a32d66a73be",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c7a3956f-3325-4c93-a5bd-2527f1320112": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
},
"42cc58eb-f1f7-46d0-bfe3-ab97c7c6182d": {
"TaskId": "e543aeb0-df2d-4466-b089-08241b4e0979",
"Status": 0,
"Comments": [
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
},
{
"Id": "4ce36f4a-5656-4377-b593-58e4b342731d",
"UPN": "ef3a18a3-b414-4c46-a660-efbb6cd52a4a",
"PostDate": "2025-12-02T15:47:37.4915553+00:00",
"Comment": "sample string 4",
"CC": [
"90b26c01-8d8c-4e4a-9f30-7af80b86bf91",
"8cd77c31-05bc-4663-9d73-b05a30d55564"
],
"Users": [
"92aa42f2-1f58-4dd2-8380-f85ff2124f4b",
"59baf75d-0113-4835-b275-23b28132b9c1"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "3d03f678-88c2-4410-a30e-a2cb744e4e73",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "3d03f678-88c2-4410-a30e-a2cb744e4e73",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "312b38d6-aa34-4d9a-a63b-59851ac0aab7",
"ConfigId": "3e44c8ae-5fb4-4b5c-84c0-9ff44b4ccf16"
}