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": "7d5761bf-0bba-4ca3-a018-27b6947068b6",
"Created": "2025-07-08T20:12:46.1152365+00:00",
"Modified": "2025-07-08T20:12:46.1152365+00:00",
"Editor": "4a208b6a-8a02-43a8-94ac-4f4d194c893e",
"PlannerTypeId": "39f20d2e-fcc2-4f98-a977-dd29e0b771bb",
"ParentPlanId": "04da886e-ae26-40e5-bd54-453ca195862a",
"PortfolioParentId": "b55029fa-5ded-4fe5-ac77-bcd55910966d",
"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": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
],
"LastComment": "2025-07-08T20:12:46.1152365+00:00",
"Integrations": [
{
"IntegrationId": "74e5f9bb-c873-423b-b7ae-fffc67f64000",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1c919f76-6971-41ea-9283-fab10a10503c",
"LastExport": "2025-07-08T20:12:46.1152365+00:00",
"LastImport": "2025-07-08T20:12:46.1152365+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "74e5f9bb-c873-423b-b7ae-fffc67f64000",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1c919f76-6971-41ea-9283-fab10a10503c",
"LastExport": "2025-07-08T20:12:46.1152365+00:00",
"LastImport": "2025-07-08T20:12:46.1152365+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-08T20:12:46.1152365+00:00",
"StatusReportId": "384c1c96-93d8-44e8-8346-552824b048c6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-08T20:12:46.1152365+00:00",
"StatusReportId": "384c1c96-93d8-44e8-8346-552824b048c6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"743fcb20-7a3a-471a-860e-7247376f3ea7",
"a881bd31-41a3-4101-a53d-bbd6ed607422"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "491a42ba-63ac-491b-b61b-d7936fd6c0f7",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T20:12:46.1152365+00:00",
"End": "2025-07-08T20:12:46.1152365+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T20:12:46.1152365+00:00",
"End": "2025-07-08T20:12:46.1152365+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9e2de3d2-b1d9-423c-bfb0-6deb02062d6a",
"BaseRate": 2.0
},
{
"ResourceId": "9e2de3d2-b1d9-423c-bfb0-6deb02062d6a",
"BaseRate": 2.0
}
]
},
{
"Id": "491a42ba-63ac-491b-b61b-d7936fd6c0f7",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T20:12:46.1152365+00:00",
"End": "2025-07-08T20:12:46.1152365+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T20:12:46.1152365+00:00",
"End": "2025-07-08T20:12:46.1152365+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9e2de3d2-b1d9-423c-bfb0-6deb02062d6a",
"BaseRate": 2.0
},
{
"ResourceId": "9e2de3d2-b1d9-423c-bfb0-6deb02062d6a",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "6a914c09-d1c6-4948-bfc5-496348241bce",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "6a914c09-d1c6-4948-bfc5-496348241bce",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "4d1c4320-4240-4fa2-bca0-1d87c47c88d1",
"LockedBy": "0d0e4da0-d64e-46cb-b539-081743fa6b67",
"LockedDate": "2025-07-08T20:12:46.1152365+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "cc523d34-3718-47ca-817d-0cd102416bd3",
"CurrentGateId": "ef8bfb94-0e7a-42d0-b402-5343ad4afeb9",
"EnteredGate": "2025-07-08T20:12:46.1152365+00:00",
"ExitedGate": "2025-07-08T20:12:46.1152365+00:00",
"GateClosed": true,
"StepStarter": "34d68ebd-9fae-40a8-a063-acc0d26ef285",
"StepApprover": "18e10fd6-45e6-4651-832c-ca5b181b3aa6",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "ab730285-c3b1-45eb-926a-2a1add399f5e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6a140e87-4041-456f-8ad3-a48bcb568554": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
},
"6afee60b-b735-4244-baaa-48979a0a2ae3": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
}
}
},
{
"StepId": "ab730285-c3b1-45eb-926a-2a1add399f5e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6a140e87-4041-456f-8ad3-a48bcb568554": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
},
"6afee60b-b735-4244-baaa-48979a0a2ae3": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "ab730285-c3b1-45eb-926a-2a1add399f5e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6a140e87-4041-456f-8ad3-a48bcb568554": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
},
"6afee60b-b735-4244-baaa-48979a0a2ae3": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
}
}
},
{
"StepId": "ab730285-c3b1-45eb-926a-2a1add399f5e",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6a140e87-4041-456f-8ad3-a48bcb568554": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
},
"6afee60b-b735-4244-baaa-48979a0a2ae3": {
"TaskId": "c6e09427-1b38-4b8e-b003-c20bbabf0d82",
"Status": 0,
"Comments": [
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
},
{
"Id": "ad857115-22f1-4743-a902-ff51d29b3ff8",
"UPN": "e0b5fbe1-6a0a-4ecc-aafc-658158664546",
"PostDate": "2025-07-08T20:12:46.1152365+00:00",
"Comment": "sample string 4",
"CC": [
"9669a792-9587-4a0e-8dd5-9b7a8bb10f58",
"72de46cb-3e18-4b3f-8b26-9a8e15e07723"
],
"Users": [
"656d49c7-f4f8-4178-b4ea-ec6fa8b6d63a",
"0938992d-38cb-47d8-a88a-38165b583477"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "313617e7-a17c-4a53-ab77-e452d769a8c6",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "313617e7-a17c-4a53-ab77-e452d769a8c6",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "6bbfe160-ba72-4d0f-8e22-d9be05b37e13",
"ConfigId": "ae34b35b-d024-45b1-822b-86026e3e4b10"
}