POST api/workplan/{PlanId}/step/approve?state={state}&comment={comment}
Approve a Process Step
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PlanId | globally unique identifier |
Required |
|
| state | ProcessState |
Required |
|
| comment | string |
Default value is |
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": "b0dd47e1-5c42-4c3a-8ddd-d4300a82392d",
"Created": "2026-07-21T13:10:19.1476188+00:00",
"Modified": "2026-07-21T13:10:19.1476188+00:00",
"Editor": "6eb2db60-f023-4a4f-81c2-5f2f04ae8c85",
"PlannerTypeId": "a4c75d03-0460-441c-90ed-1a55af9251d8",
"ParentPlanId": "1f1d2a86-d68d-4116-9965-4dca26d4db2d",
"PortfolioParentId": "7d6a110e-0a20-45ce-b811-ee389f831d94",
"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": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
],
"LastComment": "2026-07-21T13:10:19.1476188+00:00",
"Integrations": [
{
"IntegrationId": "f7305520-afaf-4c6d-9181-214cab21c027",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "aeb0b175-30ee-4e9f-ae01-53c7fbaecb12",
"LastExport": "2026-07-21T13:10:19.1476188+00:00",
"LastImport": "2026-07-21T13:10:19.1476188+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "f7305520-afaf-4c6d-9181-214cab21c027",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "aeb0b175-30ee-4e9f-ae01-53c7fbaecb12",
"LastExport": "2026-07-21T13:10:19.1476188+00:00",
"LastImport": "2026-07-21T13:10:19.1476188+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-21T13:10:19.1476188+00:00",
"StatusReportId": "bfdb6206-5c71-4e26-ad08-e9ccc014c693",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-21T13:10:19.1476188+00:00",
"StatusReportId": "bfdb6206-5c71-4e26-ad08-e9ccc014c693",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"7c81d283-8424-40e3-914c-7a5c025a3fc7",
"598ae009-e302-4ec8-bb6e-47ce33a6f696"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "40874f90-d5b4-47af-887d-311e0a91c582",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:10:19.1476188+00:00",
"End": "2026-07-21T13:10:19.1476188+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:10:19.1476188+00:00",
"End": "2026-07-21T13:10:19.1476188+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "19ce6e21-9d3e-4acf-9f4e-cf601294fde8",
"BaseRate": 2.0
},
{
"ResourceId": "19ce6e21-9d3e-4acf-9f4e-cf601294fde8",
"BaseRate": 2.0
}
]
},
{
"Id": "40874f90-d5b4-47af-887d-311e0a91c582",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:10:19.1476188+00:00",
"End": "2026-07-21T13:10:19.1476188+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:10:19.1476188+00:00",
"End": "2026-07-21T13:10:19.1476188+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "19ce6e21-9d3e-4acf-9f4e-cf601294fde8",
"BaseRate": 2.0
},
{
"ResourceId": "19ce6e21-9d3e-4acf-9f4e-cf601294fde8",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "5bc05dd7-f854-479e-b969-4dc477169b90",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "5bc05dd7-f854-479e-b969-4dc477169b90",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "65e2ffd2-596f-45f5-9e25-59a9cf07f33c",
"LockedBy": "e075bfa9-7a28-4c14-87ce-a124b4ebf43f",
"LockedDate": "2026-07-21T13:10:19.1476188+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "f10f7c8c-7469-4fe9-b037-05a06b98ce46",
"CurrentGateId": "a07d6f1f-a329-461c-90b3-d1efa0c24d35",
"EnteredGate": "2026-07-21T13:10:19.1476188+00:00",
"ExitedGate": "2026-07-21T13:10:19.1476188+00:00",
"GateClosed": true,
"StepStarter": "be573326-edb9-4753-8047-eb5a971b0978",
"StepApprover": "6e8c661c-4455-4b70-a774-06c0dd8dcb94",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "8bc87616-3c45-4187-9462-0640573c0c70",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"5af5ae28-10c6-4236-878f-d7747246cd81": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
},
"461ae0a8-63ca-4642-9016-2495c64106bc": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
}
}
},
{
"StepId": "8bc87616-3c45-4187-9462-0640573c0c70",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"5af5ae28-10c6-4236-878f-d7747246cd81": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
},
"461ae0a8-63ca-4642-9016-2495c64106bc": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "8bc87616-3c45-4187-9462-0640573c0c70",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"5af5ae28-10c6-4236-878f-d7747246cd81": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
},
"461ae0a8-63ca-4642-9016-2495c64106bc": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
}
}
},
{
"StepId": "8bc87616-3c45-4187-9462-0640573c0c70",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"5af5ae28-10c6-4236-878f-d7747246cd81": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
},
"461ae0a8-63ca-4642-9016-2495c64106bc": {
"TaskId": "cb11a67d-0cad-49d6-bce2-5011a64795cb",
"Status": 0,
"Comments": [
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
},
{
"Id": "867d19ba-6350-4bc0-967e-e803d351de73",
"UPN": "6b78b9e3-802d-4425-bf0c-716feda625cc",
"PostDate": "2026-07-21T13:10:19.1476188+00:00",
"Comment": "sample string 4",
"CC": [
"1cac0af7-b1a6-47a6-b80d-5047a9cfc5ed",
"1bff72a1-faa9-4376-a953-df12fc727d70"
],
"Users": [
"1f58ae0f-2a5c-4e3f-be9b-197291f630af",
"aff5820b-4b0e-43e9-978e-dd926302a701"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "6f510a8c-a91c-4725-be65-0541c312a344",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "6f510a8c-a91c-4725-be65-0541c312a344",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "8ccc4b3f-dd2f-46d8-99a3-c5fc85a047cc",
"ConfigId": "53a71829-d850-4df4-ac4f-a6e4d22c5004"
}