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": "61837f0a-42b1-455d-9558-77bd7f2a5af8",
"Created": "2026-07-21T13:09:50.7333982+00:00",
"Modified": "2026-07-21T13:09:50.7333982+00:00",
"Editor": "a564696a-0077-4eea-ad4b-7fd320a8f295",
"PlannerTypeId": "af3a20a2-fce6-440e-9aa3-58b94d70041e",
"ParentPlanId": "4d92332f-822b-4d46-9d62-6c2349b4103c",
"PortfolioParentId": "829fcd89-f1f6-486b-b427-931f4aaeeac8",
"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": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
],
"LastComment": "2026-07-21T13:09:50.7333982+00:00",
"Integrations": [
{
"IntegrationId": "48d1855e-ceda-43c1-8ffd-29e99ed5e1c5",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "23f0d54e-83fa-4a68-9d7f-a347eb8ddeb4",
"LastExport": "2026-07-21T13:09:50.7333982+00:00",
"LastImport": "2026-07-21T13:09:50.7333982+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "48d1855e-ceda-43c1-8ffd-29e99ed5e1c5",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "23f0d54e-83fa-4a68-9d7f-a347eb8ddeb4",
"LastExport": "2026-07-21T13:09:50.7333982+00:00",
"LastImport": "2026-07-21T13:09:50.7333982+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-21T13:09:50.749026+00:00",
"StatusReportId": "72cbcabc-7b9a-4704-a8d5-305bdf5b53da",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-21T13:09:50.749026+00:00",
"StatusReportId": "72cbcabc-7b9a-4704-a8d5-305bdf5b53da",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"8785b20c-18df-4856-920a-a6199d33d81b",
"740c0447-57fa-45ba-9e59-c59725faaf6f"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "2191a62a-b400-446e-8302-287199d39eb4",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:09:50.749026+00:00",
"End": "2026-07-21T13:09:50.749026+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:09:50.749026+00:00",
"End": "2026-07-21T13:09:50.749026+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e2128448-6edb-4e89-9d1d-6c1d58a7adde",
"BaseRate": 2.0
},
{
"ResourceId": "e2128448-6edb-4e89-9d1d-6c1d58a7adde",
"BaseRate": 2.0
}
]
},
{
"Id": "2191a62a-b400-446e-8302-287199d39eb4",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:09:50.749026+00:00",
"End": "2026-07-21T13:09:50.749026+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:09:50.749026+00:00",
"End": "2026-07-21T13:09:50.749026+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e2128448-6edb-4e89-9d1d-6c1d58a7adde",
"BaseRate": 2.0
},
{
"ResourceId": "e2128448-6edb-4e89-9d1d-6c1d58a7adde",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "3da00090-e04c-4be8-9f80-9e8648cb8e34",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "3da00090-e04c-4be8-9f80-9e8648cb8e34",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "2fe57d8d-452a-4ad7-b2cd-f5cdd4fa977a",
"LockedBy": "62d3b84f-1ddb-43f3-8f9e-86245a89d1b3",
"LockedDate": "2026-07-21T13:09:50.7646488+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "8dba1c79-a956-4ccb-9594-afeddf4b91f3",
"CurrentGateId": "75cbdedf-30c8-4117-b27f-94fd7f4b1d1d",
"EnteredGate": "2026-07-21T13:09:50.7646488+00:00",
"ExitedGate": "2026-07-21T13:09:50.7646488+00:00",
"GateClosed": true,
"StepStarter": "db4f191a-3c2f-4ec4-bf35-d4896b7a092c",
"StepApprover": "248cc1c2-60de-4705-bf63-9babb711e63b",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "07a9677f-19c4-4e93-90aa-c52adb37cf25",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"dfe97038-0abf-4651-b94b-6d78252449ec": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
},
"66a8ed18-d357-4c77-8ea5-af26caf15294": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
}
}
},
{
"StepId": "07a9677f-19c4-4e93-90aa-c52adb37cf25",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"dfe97038-0abf-4651-b94b-6d78252449ec": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
},
"66a8ed18-d357-4c77-8ea5-af26caf15294": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "07a9677f-19c4-4e93-90aa-c52adb37cf25",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"dfe97038-0abf-4651-b94b-6d78252449ec": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
},
"66a8ed18-d357-4c77-8ea5-af26caf15294": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
}
}
},
{
"StepId": "07a9677f-19c4-4e93-90aa-c52adb37cf25",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"dfe97038-0abf-4651-b94b-6d78252449ec": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
},
"66a8ed18-d357-4c77-8ea5-af26caf15294": {
"TaskId": "d5ff49a0-e307-49ad-b610-5bdfbf353bd5",
"Status": 0,
"Comments": [
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
},
{
"Id": "e55456fc-83c5-428d-9a19-a01ba55ba9fa",
"UPN": "541ff968-877b-466c-901a-07cdef85aabd",
"PostDate": "2026-07-21T13:09:50.7333982+00:00",
"Comment": "sample string 4",
"CC": [
"683dfeb2-9f95-47a4-b423-adba5863bcfb",
"a14ff0e0-8239-457f-9eff-aa6878d6a797"
],
"Users": [
"41217023-a78b-4c62-a8b5-9d31b842f3b6",
"e24f2105-b02c-4e6c-9253-81dfbe9d5b30"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5019bea5-ab22-40b4-9603-c5a3c461e665",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5019bea5-ab22-40b4-9603-c5a3c461e665",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "e556a9cd-672b-403e-86a5-fa47e6bba354",
"ConfigId": "9d0a8e81-e4a3-4ef2-a2ff-f2477044887b"
}