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": "c58fc372-0589-4343-91dc-22df0c7a0b1e",
"Created": "2026-04-30T08:10:00.6994034+00:00",
"Modified": "2026-04-30T08:10:00.6994034+00:00",
"Editor": "146034f9-7ca6-424a-9249-43e9259d0ba0",
"PlannerTypeId": "1e7f784f-3a62-4d10-9e8a-f39c307dc434",
"ParentPlanId": "8e8d51d4-d609-4304-9b0d-fb8d0363a92d",
"PortfolioParentId": "73bde0fe-f9ea-415a-a22a-334b2145a95e",
"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": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
],
"LastComment": "2026-04-30T08:10:00.6994034+00:00",
"Integrations": [
{
"IntegrationId": "e94eb254-b3d9-4db5-b25e-f58555334deb",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "4d7880c5-d6f7-455b-9411-0fbad7bd05e8",
"LastExport": "2026-04-30T08:10:00.6994034+00:00",
"LastImport": "2026-04-30T08:10:00.6994034+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "e94eb254-b3d9-4db5-b25e-f58555334deb",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "4d7880c5-d6f7-455b-9411-0fbad7bd05e8",
"LastExport": "2026-04-30T08:10:00.6994034+00:00",
"LastImport": "2026-04-30T08:10:00.6994034+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-04-30T08:10:00.6994034+00:00",
"StatusReportId": "23e262f1-755e-413b-9640-122229cdc786",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-04-30T08:10:00.6994034+00:00",
"StatusReportId": "23e262f1-755e-413b-9640-122229cdc786",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"2198f594-1126-488d-8424-4e26c2d0a6f8",
"6f325f54-9779-4676-b946-dc97bdb2a2f2"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "9a10250f-25e4-4c5a-98d5-6d2b48fc4a54",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-04-30T08:10:00.6994034+00:00",
"End": "2026-04-30T08:10:00.6994034+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-04-30T08:10:00.6994034+00:00",
"End": "2026-04-30T08:10:00.6994034+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e1387889-033c-4329-8755-b6dce8e29b7e",
"BaseRate": 2.0
},
{
"ResourceId": "e1387889-033c-4329-8755-b6dce8e29b7e",
"BaseRate": 2.0
}
]
},
{
"Id": "9a10250f-25e4-4c5a-98d5-6d2b48fc4a54",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-04-30T08:10:00.6994034+00:00",
"End": "2026-04-30T08:10:00.6994034+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-04-30T08:10:00.6994034+00:00",
"End": "2026-04-30T08:10:00.6994034+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "e1387889-033c-4329-8755-b6dce8e29b7e",
"BaseRate": 2.0
},
{
"ResourceId": "e1387889-033c-4329-8755-b6dce8e29b7e",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "fea9e11b-c327-4bc4-9a33-addb4a30d625",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "fea9e11b-c327-4bc4-9a33-addb4a30d625",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "dc4b4a6c-3ed2-4dc2-ae15-0d26ffcabdbb",
"LockedBy": "6c9f1961-b28b-494a-8220-316e8ebce404",
"LockedDate": "2026-04-30T08:10:00.6994034+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "62ecf32a-80f8-48a2-a38c-71405166f8c4",
"CurrentGateId": "8015b6c5-4b10-45e9-a07b-5802ab97b08e",
"EnteredGate": "2026-04-30T08:10:00.6994034+00:00",
"ExitedGate": "2026-04-30T08:10:00.6994034+00:00",
"GateClosed": true,
"StepStarter": "893e411e-825c-41b1-b200-80da20345aed",
"StepApprover": "46539918-0b52-412b-8966-29371f6a4a89",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "94b43bc2-aaf0-463b-b5aa-684a3ba3d88d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"3263d2aa-3d64-42f4-a9d2-5816d8a00423": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
},
"c6f6b26d-d4f7-4382-be2a-279de28bbddd": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
}
}
},
{
"StepId": "94b43bc2-aaf0-463b-b5aa-684a3ba3d88d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"3263d2aa-3d64-42f4-a9d2-5816d8a00423": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
},
"c6f6b26d-d4f7-4382-be2a-279de28bbddd": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "94b43bc2-aaf0-463b-b5aa-684a3ba3d88d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"3263d2aa-3d64-42f4-a9d2-5816d8a00423": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
},
"c6f6b26d-d4f7-4382-be2a-279de28bbddd": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
}
}
},
{
"StepId": "94b43bc2-aaf0-463b-b5aa-684a3ba3d88d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"3263d2aa-3d64-42f4-a9d2-5816d8a00423": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
},
"c6f6b26d-d4f7-4382-be2a-279de28bbddd": {
"TaskId": "8c9662bb-c594-4820-8cc5-d3db669825e4",
"Status": 0,
"Comments": [
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
},
{
"Id": "3e72e78c-a940-466d-b526-8cdfc2f1b2f5",
"UPN": "6012ff00-1014-4f0d-8048-77ffc0abaa4c",
"PostDate": "2026-04-30T08:10:00.6994034+00:00",
"Comment": "sample string 4",
"CC": [
"7728444a-8509-4ec8-9cab-68c7991142ad",
"8942d483-09a1-4d96-8c47-b73b96b64ce6"
],
"Users": [
"0bfe152e-5fa9-4ed5-926d-f2ddc498832e",
"7a549a56-8ab4-4b72-a010-b1a67286b4a5"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "bdbb778c-d555-4815-bd02-55a91d19241d",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "bdbb778c-d555-4815-bd02-55a91d19241d",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "f92d6876-115e-4091-9157-134ce304b3f6",
"ConfigId": "62cba02d-e4ad-450e-b7d7-64c62ecbd575"
}