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": "aa8735e1-4ed4-4b35-881d-d46414b40a43",
"Created": "2025-05-23T22:11:02.4692639+00:00",
"Modified": "2025-05-23T22:11:02.4692639+00:00",
"Editor": "70a97790-3732-484b-a8f1-b1e2bcacb49f",
"PlannerTypeId": "083fd4f8-f6b4-4721-9109-6f1fbdd257b1",
"ParentPlanId": "b1cec54e-76aa-4d82-8ee6-f0ba53e94f78",
"PortfolioParentId": "9df883ed-7fa6-420b-8acd-8cc64d1aa9e9",
"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": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
],
"LastComment": "2025-05-23T22:11:02.4692639+00:00",
"Integrations": [
{
"IntegrationId": "12e1249f-4134-47c6-83a7-7a8e08a6f6b8",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e34e18b8-b0d4-40eb-81b4-c9424cf6bdaa",
"LastExport": "2025-05-23T22:11:02.4692639+00:00",
"LastImport": "2025-05-23T22:11:02.4692639+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "12e1249f-4134-47c6-83a7-7a8e08a6f6b8",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e34e18b8-b0d4-40eb-81b4-c9424cf6bdaa",
"LastExport": "2025-05-23T22:11:02.4692639+00:00",
"LastImport": "2025-05-23T22:11:02.4692639+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-05-23T22:11:02.4692639+00:00",
"StatusReportId": "22c3e00e-d0b5-44b7-a454-e989435c3d63",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-05-23T22:11:02.4692639+00:00",
"StatusReportId": "22c3e00e-d0b5-44b7-a454-e989435c3d63",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"a9b68e27-43e9-4b77-8e6b-d9cd81b8859a",
"98fb3d4b-f8fe-4e28-8092-d8b81e98d4e3"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "af697f8e-40ab-49b4-9252-5f841ff50c2d",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T22:11:02.4848817+00:00",
"End": "2025-05-23T22:11:02.4848817+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T22:11:02.4848817+00:00",
"End": "2025-05-23T22:11:02.4848817+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9b460183-4f79-4259-ae32-0251fd20d9cc",
"BaseRate": 2.0
},
{
"ResourceId": "9b460183-4f79-4259-ae32-0251fd20d9cc",
"BaseRate": 2.0
}
]
},
{
"Id": "af697f8e-40ab-49b4-9252-5f841ff50c2d",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T22:11:02.4848817+00:00",
"End": "2025-05-23T22:11:02.4848817+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T22:11:02.4848817+00:00",
"End": "2025-05-23T22:11:02.4848817+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9b460183-4f79-4259-ae32-0251fd20d9cc",
"BaseRate": 2.0
},
{
"ResourceId": "9b460183-4f79-4259-ae32-0251fd20d9cc",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "cb2128d0-b56b-4591-acaa-0e29a208c64b",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "cb2128d0-b56b-4591-acaa-0e29a208c64b",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "c97d950d-8c91-43ff-ab59-048753caf8bf",
"LockedBy": "2c07b8c9-97fb-4880-b965-eee83d31e718",
"LockedDate": "2025-05-23T22:11:02.4848817+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "fca1fb81-d8a9-448f-892f-9a6edaa9fdd6",
"CurrentGateId": "bc286bd3-a3e5-4aba-a7c7-a7d858834b0c",
"EnteredGate": "2025-05-23T22:11:02.4848817+00:00",
"ExitedGate": "2025-05-23T22:11:02.4848817+00:00",
"GateClosed": true,
"StepStarter": "0ce6b7d2-6216-4d24-be2f-b3edbd16610d",
"StepApprover": "ca4be9ff-5fd8-4c04-9b01-08321ed4b62f",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "b26fa3ba-73c7-4ef2-8ac5-f78f5c9561db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"593c6b0c-bd5c-414c-9515-2f0f043336e7": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
},
"1fda9cfe-760a-4b71-82c2-b17a43e9a441": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
}
}
},
{
"StepId": "b26fa3ba-73c7-4ef2-8ac5-f78f5c9561db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"593c6b0c-bd5c-414c-9515-2f0f043336e7": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
},
"1fda9cfe-760a-4b71-82c2-b17a43e9a441": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "b26fa3ba-73c7-4ef2-8ac5-f78f5c9561db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"593c6b0c-bd5c-414c-9515-2f0f043336e7": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
},
"1fda9cfe-760a-4b71-82c2-b17a43e9a441": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
}
}
},
{
"StepId": "b26fa3ba-73c7-4ef2-8ac5-f78f5c9561db",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"593c6b0c-bd5c-414c-9515-2f0f043336e7": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
},
"1fda9cfe-760a-4b71-82c2-b17a43e9a441": {
"TaskId": "6745a0b0-6d8e-4e51-ae97-32f11c857ec9",
"Status": 0,
"Comments": [
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
},
{
"Id": "83012162-95c1-4460-a4a8-a1e101b94226",
"UPN": "b78fa3a3-bbd9-47b9-bc5b-99c19e1dc270",
"PostDate": "2025-05-23T22:11:02.4692639+00:00",
"Comment": "sample string 4",
"CC": [
"4b2302d0-4955-4296-bc3b-4b6c5106a7c6",
"89c8273e-58e4-443c-8fe2-d89459fd0fcf"
],
"Users": [
"ecf8aecf-0f8a-48a1-89fb-25a66df9cb13",
"3df74b58-9845-4a03-8641-45b2d927c959"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "da68677a-d8aa-4c02-8a04-2e254e25eb15",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "da68677a-d8aa-4c02-8a04-2e254e25eb15",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "9f4a2334-7f89-4973-b348-f7e1cba46516",
"ConfigId": "c5615027-9410-46d5-9b30-f70c06ebca61"
}