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. |
|
| IsPrivate | boolean |
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": "bb92474b-d72b-44b5-aed9-672bac13071a",
"Created": "2026-09-29T19:22:23.1103473+00:00",
"Modified": "2026-09-29T19:22:23.1103473+00:00",
"Editor": "e84e48e0-846d-4c44-b8d3-df3734694269",
"PlannerTypeId": "f94c37ba-7500-442f-bd1e-5793b727d9cd",
"ParentPlanId": "5825d18b-251a-4955-a64e-e96ec242fd13",
"PortfolioParentId": "df65d604-e32a-49e8-8b2a-42d59a80dcfd",
"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": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
],
"LastComment": "2026-09-29T19:22:23.1103473+00:00",
"Integrations": [
{
"IntegrationId": "910b5d4e-822a-422a-8cd6-7fa34e0d74a4",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "2cd9cc69-ca27-49df-b329-239498c0bc6b",
"LastExport": "2026-09-29T19:22:23.1103473+00:00",
"LastImport": "2026-09-29T19:22:23.1103473+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "910b5d4e-822a-422a-8cd6-7fa34e0d74a4",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "2cd9cc69-ca27-49df-b329-239498c0bc6b",
"LastExport": "2026-09-29T19:22:23.1103473+00:00",
"LastImport": "2026-09-29T19:22:23.1103473+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-09-29T19:22:23.1103473+00:00",
"StatusReportId": "0f144e0f-d09f-4b10-9c7e-ed28c16a679d",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-09-29T19:22:23.1103473+00:00",
"StatusReportId": "0f144e0f-d09f-4b10-9c7e-ed28c16a679d",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"2f693136-79f2-4093-80e6-780bd48d326f",
"5d84c3e4-505a-43cb-bf61-8fa5a8e22b56"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "c4dcec47-ab5f-43e2-8471-33d22a867d12",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:22:23.1103473+00:00",
"End": "2026-09-29T19:22:23.1103473+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:22:23.1103473+00:00",
"End": "2026-09-29T19:22:23.1103473+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "cea52450-458c-4933-8779-6d0b56634123",
"BaseRate": 2.0
},
{
"ResourceId": "cea52450-458c-4933-8779-6d0b56634123",
"BaseRate": 2.0
}
]
},
{
"Id": "c4dcec47-ab5f-43e2-8471-33d22a867d12",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:22:23.1103473+00:00",
"End": "2026-09-29T19:22:23.1103473+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:22:23.1103473+00:00",
"End": "2026-09-29T19:22:23.1103473+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "cea52450-458c-4933-8779-6d0b56634123",
"BaseRate": 2.0
},
{
"ResourceId": "cea52450-458c-4933-8779-6d0b56634123",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "cce7331d-daf1-4131-8181-4a0f11832c88",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "cce7331d-daf1-4131-8181-4a0f11832c88",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "922b97a4-f0ac-4837-bb5b-300d20d3ef5d",
"LockedBy": "0ca428ea-2fbe-46a0-8d77-b590e8d660f6",
"LockedDate": "2026-09-29T19:22:23.1103473+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "705c2fa3-65c6-4fe0-9623-4f67d2f99cdc",
"CurrentGateId": "fd3747b4-4800-412c-bac9-bee255136350",
"EnteredGate": "2026-09-29T19:22:23.1103473+00:00",
"ExitedGate": "2026-09-29T19:22:23.1103473+00:00",
"GateClosed": true,
"StepStarter": "7f198356-c0b4-47f2-afe8-77cabac5879b",
"StepApprover": "0907d97a-e1fa-4293-a1fb-0bb7c4a70760",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "f572e806-cf41-42ff-be71-b2e3b10153d3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8ff67514-9bd8-4718-9896-c42e09d7c173": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
},
"ba86fd83-8a3b-4ff9-bc7e-8a18c8e92e47": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
}
}
},
{
"StepId": "f572e806-cf41-42ff-be71-b2e3b10153d3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8ff67514-9bd8-4718-9896-c42e09d7c173": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
},
"ba86fd83-8a3b-4ff9-bc7e-8a18c8e92e47": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "f572e806-cf41-42ff-be71-b2e3b10153d3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8ff67514-9bd8-4718-9896-c42e09d7c173": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
},
"ba86fd83-8a3b-4ff9-bc7e-8a18c8e92e47": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
}
}
},
{
"StepId": "f572e806-cf41-42ff-be71-b2e3b10153d3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"8ff67514-9bd8-4718-9896-c42e09d7c173": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
},
"ba86fd83-8a3b-4ff9-bc7e-8a18c8e92e47": {
"TaskId": "3168a3de-157b-4c05-945c-c7c1235fe1e7",
"Status": 0,
"Comments": [
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
},
{
"Id": "eef123f2-fc50-4137-84a8-f344e19e2b5a",
"UPN": "c0dc670e-023e-4455-9782-c1d080bf941d",
"PostDate": "2026-09-29T19:22:23.1103473+00:00",
"Comment": "sample string 4",
"CC": [
"fdf1d143-d8c0-4918-a6f5-cab70338b4af",
"6be57a84-06b6-4bf2-8e8f-d57567da3e61"
],
"Users": [
"2cdac70c-8273-456a-afc8-9c012bd9296e",
"c54b3527-6e04-4dcb-b2b3-f0480941b3f6"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "41f5fb9c-d1dc-4037-809b-f19967ffc73f",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "41f5fb9c-d1dc-4037-809b-f19967ffc73f",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"IsPrivate": true,
"id": "d648b3bb-1dfa-4410-8c54-3648ea568774",
"ConfigId": "6b8ea19e-6884-4d55-9195-43366a8b1965"
}