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": "606ff5fd-3c1f-4512-86c9-508014acecbd",
"Created": "2026-05-02T16:49:24.0991964+00:00",
"Modified": "2026-05-02T16:49:24.0991964+00:00",
"Editor": "91ac7c9d-f282-4c64-95cf-7679f39810fb",
"PlannerTypeId": "38ebf32e-cf33-4ece-9c03-797211607540",
"ParentPlanId": "f1db72bf-8a70-4308-8b64-b8614f5102be",
"PortfolioParentId": "6d433814-b281-47aa-9bc1-8019af262811",
"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": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
],
"LastComment": "2026-05-02T16:49:24.0991964+00:00",
"Integrations": [
{
"IntegrationId": "516add5c-f272-4286-b395-1cb216401d56",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "08d1ab57-96bc-4e69-8adb-f70041f8e162",
"LastExport": "2026-05-02T16:49:24.0991964+00:00",
"LastImport": "2026-05-02T16:49:24.0991964+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "516add5c-f272-4286-b395-1cb216401d56",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "08d1ab57-96bc-4e69-8adb-f70041f8e162",
"LastExport": "2026-05-02T16:49:24.0991964+00:00",
"LastImport": "2026-05-02T16:49:24.0991964+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-05-02T16:49:24.0991964+00:00",
"StatusReportId": "8ebba562-484f-4ecb-8b38-2a28777db662",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-05-02T16:49:24.0991964+00:00",
"StatusReportId": "8ebba562-484f-4ecb-8b38-2a28777db662",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"f733252b-4da3-409c-9a02-aab156f1f24f",
"3d635095-d2f3-4b78-8b64-4456ae45597b"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "2e55a923-ec70-47e4-a8ed-68de1a6a6fa6",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-05-02T16:49:24.0991964+00:00",
"End": "2026-05-02T16:49:24.0991964+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-05-02T16:49:24.0991964+00:00",
"End": "2026-05-02T16:49:24.0991964+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e585e97f-72bb-4e37-8409-e60c40594f92",
"BaseRate": 2.0
},
{
"ResourceId": "e585e97f-72bb-4e37-8409-e60c40594f92",
"BaseRate": 2.0
}
]
},
{
"Id": "2e55a923-ec70-47e4-a8ed-68de1a6a6fa6",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-05-02T16:49:24.0991964+00:00",
"End": "2026-05-02T16:49:24.0991964+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-05-02T16:49:24.0991964+00:00",
"End": "2026-05-02T16:49:24.0991964+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e585e97f-72bb-4e37-8409-e60c40594f92",
"BaseRate": 2.0
},
{
"ResourceId": "e585e97f-72bb-4e37-8409-e60c40594f92",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "ce2827f9-09e0-4e86-ac14-b5ea8ddebff2",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "ce2827f9-09e0-4e86-ac14-b5ea8ddebff2",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "b3e0c753-1ba9-43bc-a118-32ceb5a14e14",
"LockedBy": "63343a8b-2c73-4983-9df2-47cd9f261da6",
"LockedDate": "2026-05-02T16:49:24.0991964+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "0244dab2-0bb7-4d00-9c36-9c4f75235633",
"CurrentGateId": "17857190-6826-4002-8b9d-09f86e85747a",
"EnteredGate": "2026-05-02T16:49:24.0991964+00:00",
"ExitedGate": "2026-05-02T16:49:24.0991964+00:00",
"GateClosed": true,
"StepStarter": "6c7a5733-a2eb-4dea-a872-942b098974e9",
"StepApprover": "c06707d5-3a38-4177-ac52-5e34b518c748",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "90ce1df3-474f-41fb-b830-9fdbab220a4e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"40d4df9e-ae62-4644-9f52-353c34378e64": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
},
"6d67b648-b747-4430-b2c2-2d02d7dab68d": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
}
}
},
{
"StepId": "90ce1df3-474f-41fb-b830-9fdbab220a4e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"40d4df9e-ae62-4644-9f52-353c34378e64": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
},
"6d67b648-b747-4430-b2c2-2d02d7dab68d": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "90ce1df3-474f-41fb-b830-9fdbab220a4e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"40d4df9e-ae62-4644-9f52-353c34378e64": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
},
"6d67b648-b747-4430-b2c2-2d02d7dab68d": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
}
}
},
{
"StepId": "90ce1df3-474f-41fb-b830-9fdbab220a4e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"40d4df9e-ae62-4644-9f52-353c34378e64": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
},
"6d67b648-b747-4430-b2c2-2d02d7dab68d": {
"TaskId": "bea8d8e7-6b52-4cf2-95ad-737ac8a9e3c6",
"Status": 0,
"Comments": [
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
},
{
"Id": "4bda6580-b9c6-4550-a8a9-a7a9bd499e0b",
"UPN": "ba8caf5c-2d75-4e74-b3bc-5b651228061a",
"PostDate": "2026-05-02T16:49:24.0991964+00:00",
"Comment": "sample string 4",
"CC": [
"559ce5ac-8b13-48e8-b9a5-6bbeac13026e",
"9a631592-d1b0-416b-8171-b8e0a765370c"
],
"Users": [
"4e582d56-8dd9-4bad-b0db-dcfaf76ed92d",
"bf6c2bd8-541a-4b19-bad4-4c44e5641fda"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "e8becd8b-447b-4657-9aca-ceba71a81130",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "e8becd8b-447b-4657-9aca-ceba71a81130",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "0bda3d45-b8f5-4a46-8096-a7f714b3e870",
"ConfigId": "50bb440e-0bd4-4074-a1a1-b7f3a478189c"
}