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": "6fde39fe-72cb-4919-8372-4c186de2aabf",
"Created": "2025-09-03T18:09:03.3064028+00:00",
"Modified": "2025-09-03T18:09:03.3064028+00:00",
"Editor": "eea37ed5-7334-4908-85d9-e1e4b674d6e5",
"PlannerTypeId": "178b3ad3-0199-4609-800a-5cf9d35fab14",
"ParentPlanId": "757d698b-98e7-4085-86ca-228f2f914426",
"PortfolioParentId": "16a300e3-a959-48c2-9add-f2c44dc4d83d",
"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": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
],
"LastComment": "2025-09-03T18:09:03.3064028+00:00",
"Integrations": [
{
"IntegrationId": "51bc3f66-3a5c-4809-bd2b-e0efdd024a11",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "921ee3bc-f562-4cf5-abfc-8f3c39e8e983",
"LastExport": "2025-09-03T18:09:03.3064028+00:00",
"LastImport": "2025-09-03T18:09:03.3064028+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "51bc3f66-3a5c-4809-bd2b-e0efdd024a11",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "921ee3bc-f562-4cf5-abfc-8f3c39e8e983",
"LastExport": "2025-09-03T18:09:03.3064028+00:00",
"LastImport": "2025-09-03T18:09:03.3064028+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-09-03T18:09:03.3064028+00:00",
"StatusReportId": "9e6220f6-646d-468e-a342-aaded4f5d6ae",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-09-03T18:09:03.3064028+00:00",
"StatusReportId": "9e6220f6-646d-468e-a342-aaded4f5d6ae",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"ee96fa6c-32c4-4fa3-9a30-3ffb03e254ba",
"57c5717e-cd22-476b-ac4c-d1d001786476"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "092caa60-8792-4de5-b9f7-9dd05a4caa77",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-09-03T18:09:03.3064028+00:00",
"End": "2025-09-03T18:09:03.3064028+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-09-03T18:09:03.3064028+00:00",
"End": "2025-09-03T18:09:03.3064028+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "afa3e3cb-f291-4171-8159-b2d9118a13b5",
"BaseRate": 2.0
},
{
"ResourceId": "afa3e3cb-f291-4171-8159-b2d9118a13b5",
"BaseRate": 2.0
}
]
},
{
"Id": "092caa60-8792-4de5-b9f7-9dd05a4caa77",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-09-03T18:09:03.3064028+00:00",
"End": "2025-09-03T18:09:03.3064028+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-09-03T18:09:03.3064028+00:00",
"End": "2025-09-03T18:09:03.3064028+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "afa3e3cb-f291-4171-8159-b2d9118a13b5",
"BaseRate": 2.0
},
{
"ResourceId": "afa3e3cb-f291-4171-8159-b2d9118a13b5",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "fbe7d06d-e5ce-4b09-bdbd-d72cb5d80e61",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "fbe7d06d-e5ce-4b09-bdbd-d72cb5d80e61",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "615bcffc-9881-44b5-85a4-4575e26ef100",
"LockedBy": "73cb86c6-61fe-433b-bccc-dba7af273045",
"LockedDate": "2025-09-03T18:09:03.3064028+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "f906769b-ecbb-4cdc-9e96-86cf725661b3",
"CurrentGateId": "418b4f10-1dbb-4f9a-9b2c-94ebd08e806d",
"EnteredGate": "2025-09-03T18:09:03.3064028+00:00",
"ExitedGate": "2025-09-03T18:09:03.3064028+00:00",
"GateClosed": true,
"StepStarter": "fd0c6746-b9bc-4eb1-9d6a-06c4cb153021",
"StepApprover": "5027e85e-2d4e-4855-bb35-9f8a844e9d9a",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "64889e4e-8cb5-42f4-b013-44e81e803b46",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e88bef8a-776c-49fa-bc10-bd09a0fd9ffd": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
},
"3c0ae1b3-961b-45cc-82f8-b6458d2bdba1": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
}
}
},
{
"StepId": "64889e4e-8cb5-42f4-b013-44e81e803b46",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e88bef8a-776c-49fa-bc10-bd09a0fd9ffd": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
},
"3c0ae1b3-961b-45cc-82f8-b6458d2bdba1": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "64889e4e-8cb5-42f4-b013-44e81e803b46",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e88bef8a-776c-49fa-bc10-bd09a0fd9ffd": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
},
"3c0ae1b3-961b-45cc-82f8-b6458d2bdba1": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
}
}
},
{
"StepId": "64889e4e-8cb5-42f4-b013-44e81e803b46",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"e88bef8a-776c-49fa-bc10-bd09a0fd9ffd": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
},
"3c0ae1b3-961b-45cc-82f8-b6458d2bdba1": {
"TaskId": "bee38063-a592-4ef3-b9dc-ecf0b37fc370",
"Status": 0,
"Comments": [
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
},
{
"Id": "501249f5-d906-470c-b36b-c55a2939c8d8",
"UPN": "c45b85a5-3745-42cb-bfd9-3ce21f47467a",
"PostDate": "2025-09-03T18:09:03.3064028+00:00",
"Comment": "sample string 4",
"CC": [
"a4f8bd09-c584-4012-ab0f-4b9afd5ffbd3",
"e475ce2a-6cd8-4089-8b7d-d182a845f38a"
],
"Users": [
"bd48f629-c5f6-4ac1-aabb-c80e40d53202",
"37b7a9ed-c9cf-4df0-85cf-ea54880eafc4"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "fd6bf4c0-29c1-4da4-8780-1ad8bc088207",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "fd6bf4c0-29c1-4da4-8780-1ad8bc088207",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "83343680-949f-4cc0-8144-de5da7c8137e",
"ConfigId": "ffc806ab-361d-4c55-9cba-e20ecccac635"
}