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. |
|
| IsPrivate | boolean |
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": "faf2af39-79b2-401f-99c4-c7232962ee9b",
"Created": "2026-09-29T19:22:21.0066461+00:00",
"Modified": "2026-09-29T19:22:21.0066461+00:00",
"Editor": "e01dea3c-42fa-4bbc-a9a4-54b539309797",
"PlannerTypeId": "fbf82eb6-86c3-4caf-a3cb-00a3b8853d0e",
"ParentPlanId": "e81f3378-98ea-46a3-aacd-003a523fb236",
"PortfolioParentId": "267b046c-e82b-41df-ad27-1b2a367d44a9",
"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": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
],
"LastComment": "2026-09-29T19:22:21.0066461+00:00",
"Integrations": [
{
"IntegrationId": "b85bc213-f287-43e4-b1e1-c439d5c0a379",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "65b1a6a6-0cae-4fc9-99bc-157b23c5f341",
"LastExport": "2026-09-29T19:22:21.0066461+00:00",
"LastImport": "2026-09-29T19:22:21.0066461+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "b85bc213-f287-43e4-b1e1-c439d5c0a379",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "65b1a6a6-0cae-4fc9-99bc-157b23c5f341",
"LastExport": "2026-09-29T19:22:21.0066461+00:00",
"LastImport": "2026-09-29T19:22:21.0066461+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-09-29T19:22:21.0066461+00:00",
"StatusReportId": "a0e883b4-2ce4-4240-aee2-f9d980ceff0a",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-09-29T19:22:21.0066461+00:00",
"StatusReportId": "a0e883b4-2ce4-4240-aee2-f9d980ceff0a",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"c30b2f62-6bb7-4f0b-898c-ff9492b21a67",
"5ff0a94e-b171-4a62-80fb-4da2dd617d64"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "6a5a2ac2-8ba9-4131-858d-a92e78ba79f4",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:22:21.0066461+00:00",
"End": "2026-09-29T19:22:21.0066461+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:22:21.0066461+00:00",
"End": "2026-09-29T19:22:21.0066461+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "b84e45be-d660-46f3-964d-473bdc4f14ec",
"BaseRate": 2.0
},
{
"ResourceId": "b84e45be-d660-46f3-964d-473bdc4f14ec",
"BaseRate": 2.0
}
]
},
{
"Id": "6a5a2ac2-8ba9-4131-858d-a92e78ba79f4",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:22:21.0066461+00:00",
"End": "2026-09-29T19:22:21.0066461+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:22:21.0066461+00:00",
"End": "2026-09-29T19:22:21.0066461+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "b84e45be-d660-46f3-964d-473bdc4f14ec",
"BaseRate": 2.0
},
{
"ResourceId": "b84e45be-d660-46f3-964d-473bdc4f14ec",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "ab485ca8-d304-49bc-84f5-ea7b49596a8c",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "ab485ca8-d304-49bc-84f5-ea7b49596a8c",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "1e95eeda-0117-45de-a23d-79c6aecc9eed",
"LockedBy": "3c96c3e5-6bcb-4194-a3b5-f1a66acdc4d3",
"LockedDate": "2026-09-29T19:22:21.0066461+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "9ccbee1b-ecba-40f7-bda2-22edf08c50bb",
"CurrentGateId": "f2bb2005-6481-4bca-a8f0-618d501168d5",
"EnteredGate": "2026-09-29T19:22:21.0066461+00:00",
"ExitedGate": "2026-09-29T19:22:21.0066461+00:00",
"GateClosed": true,
"StepStarter": "4a7dfbc9-278f-46a0-88c0-4c99707147fa",
"StepApprover": "7bca6e2b-31ef-4997-9f8a-4a6816190643",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "8857933b-eafc-4642-acc8-2e3a4af36b84",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1e62937d-74cb-48e3-88b2-b1c2db1f17e7": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
},
"f1aa4284-aa8d-4316-a91f-ed3b92ff07e1": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
}
}
},
{
"StepId": "8857933b-eafc-4642-acc8-2e3a4af36b84",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1e62937d-74cb-48e3-88b2-b1c2db1f17e7": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
},
"f1aa4284-aa8d-4316-a91f-ed3b92ff07e1": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "8857933b-eafc-4642-acc8-2e3a4af36b84",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1e62937d-74cb-48e3-88b2-b1c2db1f17e7": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
},
"f1aa4284-aa8d-4316-a91f-ed3b92ff07e1": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
}
}
},
{
"StepId": "8857933b-eafc-4642-acc8-2e3a4af36b84",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"1e62937d-74cb-48e3-88b2-b1c2db1f17e7": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
},
"f1aa4284-aa8d-4316-a91f-ed3b92ff07e1": {
"TaskId": "79483a6e-21cc-4f99-b626-717b4b434c54",
"Status": 0,
"Comments": [
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
},
{
"Id": "db1c1223-c8a2-4380-879e-7740f22f06f6",
"UPN": "0ece3d5f-cf66-46eb-a2fb-4e95d96148d8",
"PostDate": "2026-09-29T19:22:21.0066461+00:00",
"Comment": "sample string 4",
"CC": [
"59fd21c6-e2fa-4750-ab1a-e110aaa9ab2a",
"884b0526-0c17-449b-8c89-a30efdd05ef8"
],
"Users": [
"7a66dde1-c189-46fe-be4b-dba6d8d9d740",
"0ebde6ac-ad80-4e33-9992-ff45b3d708e6"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "0fbde4cd-409e-4774-94d9-03a7cc6a49f7",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "0fbde4cd-409e-4774-94d9-03a7cc6a49f7",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"IsPrivate": true,
"id": "bb751c58-f841-4797-b5be-f0f682b294c1",
"ConfigId": "c4c5c18c-fc87-4d2e-9443-61e0aeef8a9c"
}