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": "04ee60dc-57ab-4bd0-b907-5a0807a20f0d",
"Created": "2025-10-19T09:13:27.4333922+00:00",
"Modified": "2025-10-19T09:13:27.4333922+00:00",
"Editor": "02d659cc-5821-4752-8ba6-6cf2da8e6e50",
"PlannerTypeId": "20f7a8c5-5d0f-468e-90fe-b29473a6cb26",
"ParentPlanId": "cc10d2fa-94f4-4cd6-8056-7b9f71339563",
"PortfolioParentId": "6c913a6e-b0ea-472c-ab49-1f06b0dc4225",
"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": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
],
"LastComment": "2025-10-19T09:13:27.4333922+00:00",
"Integrations": [
{
"IntegrationId": "a479baa6-718b-4566-91be-21f472e54561",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "52d4d15e-40b8-4999-9824-ad817f686d96",
"LastExport": "2025-10-19T09:13:27.4333922+00:00",
"LastImport": "2025-10-19T09:13:27.4333922+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "a479baa6-718b-4566-91be-21f472e54561",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "52d4d15e-40b8-4999-9824-ad817f686d96",
"LastExport": "2025-10-19T09:13:27.4333922+00:00",
"LastImport": "2025-10-19T09:13:27.4333922+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-10-19T09:13:27.4333922+00:00",
"StatusReportId": "f44c0dd9-2c31-41cf-9926-56fc7d987bee",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-10-19T09:13:27.4333922+00:00",
"StatusReportId": "f44c0dd9-2c31-41cf-9926-56fc7d987bee",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"9a097e28-4e1d-4c75-b617-6c39bdbdb2c5",
"015a120c-8b17-47b7-8e05-fb5de0c71dc8"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "2455b179-c8ce-45d3-8e58-d7bb30e703a8",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-19T09:13:27.4333922+00:00",
"End": "2025-10-19T09:13:27.4333922+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-19T09:13:27.4333922+00:00",
"End": "2025-10-19T09:13:27.4333922+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9ad44b56-5318-4bb9-ad4c-ce857a9be187",
"BaseRate": 2.0
},
{
"ResourceId": "9ad44b56-5318-4bb9-ad4c-ce857a9be187",
"BaseRate": 2.0
}
]
},
{
"Id": "2455b179-c8ce-45d3-8e58-d7bb30e703a8",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-19T09:13:27.4333922+00:00",
"End": "2025-10-19T09:13:27.4333922+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-19T09:13:27.4333922+00:00",
"End": "2025-10-19T09:13:27.4333922+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9ad44b56-5318-4bb9-ad4c-ce857a9be187",
"BaseRate": 2.0
},
{
"ResourceId": "9ad44b56-5318-4bb9-ad4c-ce857a9be187",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "508dbf9d-1ca4-4cf5-a3e4-b32b0211dfec",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "508dbf9d-1ca4-4cf5-a3e4-b32b0211dfec",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "1ea33fb2-4495-4a9d-99f0-068aa1aade96",
"LockedBy": "c08d95e1-8a00-4cf9-a549-ffd20ea4e59b",
"LockedDate": "2025-10-19T09:13:27.4333922+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "6a471474-8b6b-4e22-ab80-00e83523644d",
"CurrentGateId": "f6be17e2-c9d9-466a-911f-b9efa30df776",
"EnteredGate": "2025-10-19T09:13:27.4333922+00:00",
"ExitedGate": "2025-10-19T09:13:27.4333922+00:00",
"GateClosed": true,
"StepStarter": "73abbaf8-1726-42fc-98a1-a2f9f7b2f6ae",
"StepApprover": "25227e75-8eec-4599-b6a9-8e9715615c44",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "3a9acda9-7379-436a-bd1c-98792c3aa826",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"b26bd74f-dc60-495e-b867-a26da7ebedde": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
},
"4b064234-678f-4318-8d14-5aa77552f68c": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
}
}
},
{
"StepId": "3a9acda9-7379-436a-bd1c-98792c3aa826",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"b26bd74f-dc60-495e-b867-a26da7ebedde": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
},
"4b064234-678f-4318-8d14-5aa77552f68c": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "3a9acda9-7379-436a-bd1c-98792c3aa826",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"b26bd74f-dc60-495e-b867-a26da7ebedde": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
},
"4b064234-678f-4318-8d14-5aa77552f68c": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
}
}
},
{
"StepId": "3a9acda9-7379-436a-bd1c-98792c3aa826",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"b26bd74f-dc60-495e-b867-a26da7ebedde": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
},
"4b064234-678f-4318-8d14-5aa77552f68c": {
"TaskId": "78acda86-1aa7-40ff-9723-32ed8afb1c92",
"Status": 0,
"Comments": [
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
},
{
"Id": "fa02bb14-68ef-429f-acec-e294acd01f4a",
"UPN": "5694c30c-3dc5-41a9-a975-1fe7067c0cfa",
"PostDate": "2025-10-19T09:13:27.4333922+00:00",
"Comment": "sample string 4",
"CC": [
"ea7c8ac3-3c3c-4aed-84ca-45f8da43d6c2",
"af4758f6-070c-4259-a486-9bbfcd6e6990"
],
"Users": [
"adc984fe-02af-4940-bc0a-5821539624ae",
"f1eab91b-520f-4ca1-abab-a5e35656b38d"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5612d71c-36ab-4896-b17d-8687d3e380b5",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5612d71c-36ab-4896-b17d-8687d3e380b5",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "d134688c-3e2e-4a78-b700-e093b3fec63a",
"ConfigId": "d5594e42-8865-4d16-8f68-52b4fae54a72"
}