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": "3bfc43f2-c97d-4f30-a779-67b104ccf3a7",
"Created": "2025-04-04T02:43:23.5078092+00:00",
"Modified": "2025-04-04T02:43:23.5078092+00:00",
"Editor": "c6e952c3-25ee-4e55-8fec-4d7a18f42950",
"PlannerTypeId": "08a974c8-675f-406e-beef-5525e33ca1e7",
"ParentPlanId": "d469adb6-5834-4701-92b6-7f34fabfce87",
"PortfolioParentId": "9142c3f8-2955-4827-9c6b-d79c72e366ae",
"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": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
],
"LastComment": "2025-04-04T02:43:23.5078092+00:00",
"Integrations": [
{
"IntegrationId": "926b42b3-2874-437f-bdb5-9264dd51867a",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e69feb1b-6266-42c3-8a2c-fb07c75988ee",
"LastExport": "2025-04-04T02:43:23.5078092+00:00",
"LastImport": "2025-04-04T02:43:23.5078092+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "926b42b3-2874-437f-bdb5-9264dd51867a",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e69feb1b-6266-42c3-8a2c-fb07c75988ee",
"LastExport": "2025-04-04T02:43:23.5078092+00:00",
"LastImport": "2025-04-04T02:43:23.5078092+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-04-04T02:43:23.5234343+00:00",
"StatusReportId": "2a62aa6e-8acc-47a4-bc56-7cd667437369",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-04-04T02:43:23.5234343+00:00",
"StatusReportId": "2a62aa6e-8acc-47a4-bc56-7cd667437369",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"cedaa4ee-8516-4c0b-9139-bdc8362412e4",
"a320467c-ab30-4831-8bfd-2d13ede9ff1f"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "f39afa9a-e1ff-4345-97c7-333c8a5e3a79",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:43:23.5234343+00:00",
"End": "2025-04-04T02:43:23.5234343+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:43:23.5234343+00:00",
"End": "2025-04-04T02:43:23.5234343+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "39ef9397-651b-45b5-bcae-eca72ea1ee71",
"BaseRate": 2.0
},
{
"ResourceId": "39ef9397-651b-45b5-bcae-eca72ea1ee71",
"BaseRate": 2.0
}
]
},
{
"Id": "f39afa9a-e1ff-4345-97c7-333c8a5e3a79",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:43:23.5234343+00:00",
"End": "2025-04-04T02:43:23.5234343+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:43:23.5234343+00:00",
"End": "2025-04-04T02:43:23.5234343+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "39ef9397-651b-45b5-bcae-eca72ea1ee71",
"BaseRate": 2.0
},
{
"ResourceId": "39ef9397-651b-45b5-bcae-eca72ea1ee71",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "a58a6772-8d87-4361-be54-0ec64ba308d9",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "a58a6772-8d87-4361-be54-0ec64ba308d9",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "3321bf2a-51b6-42c3-9cbf-6a4c612bc7db",
"LockedBy": "f8fcba2e-1279-49a8-bf1a-5bb253a08760",
"LockedDate": "2025-04-04T02:43:23.5234343+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "0fe716f7-15bb-4d94-aaa0-3bf2286a5e0e",
"CurrentGateId": "172406f8-00b7-41f7-93d6-7e7bbd135a9e",
"EnteredGate": "2025-04-04T02:43:23.5234343+00:00",
"ExitedGate": "2025-04-04T02:43:23.5234343+00:00",
"GateClosed": true,
"StepStarter": "94453947-d5bc-4ba3-84dc-3cde490358d9",
"StepApprover": "9d816a58-ab2b-45f0-aae4-1ce2cf119715",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "cc390add-fdcc-4dc1-adf4-47572191f88c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"8d011ce9-0aa6-4af9-b0b5-3f5b011e5054": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
},
"6d237d19-41c0-4096-8124-02ed3f074cad": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
}
}
},
{
"StepId": "cc390add-fdcc-4dc1-adf4-47572191f88c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"8d011ce9-0aa6-4af9-b0b5-3f5b011e5054": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
},
"6d237d19-41c0-4096-8124-02ed3f074cad": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "cc390add-fdcc-4dc1-adf4-47572191f88c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"8d011ce9-0aa6-4af9-b0b5-3f5b011e5054": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
},
"6d237d19-41c0-4096-8124-02ed3f074cad": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
}
}
},
{
"StepId": "cc390add-fdcc-4dc1-adf4-47572191f88c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"8d011ce9-0aa6-4af9-b0b5-3f5b011e5054": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
},
"6d237d19-41c0-4096-8124-02ed3f074cad": {
"TaskId": "13db8781-1999-4fd4-ac0f-8197ee82cffa",
"Status": 0,
"Comments": [
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
},
{
"Id": "ee409573-dccb-4251-8485-3af83620a24e",
"UPN": "a882430a-7c15-43be-8163-159dff62cf69",
"PostDate": "2025-04-04T02:43:23.5078092+00:00",
"Comment": "sample string 4",
"CC": [
"6cff27a1-8d38-4e97-b847-5e8b21f3a3d5",
"f7538c49-449f-43eb-aa63-095a68f6fc2a"
],
"Users": [
"55739dbf-019e-4b16-9891-f9e976bb31cf",
"e5ecccab-27a0-4f62-ae02-55ef0d64940a"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "bfcf555f-853a-4b5f-885a-93961eee1e33",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "bfcf555f-853a-4b5f-885a-93961eee1e33",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "7d6dbf42-5f8c-4bdb-9db2-c0fd6a4fe834",
"ConfigId": "d4cfee65-2e4c-46d6-a33a-80a3cc1761e4"
}