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": "572b095a-01d8-4b37-a74f-374b13c84bd6",
"Created": "2025-04-04T02:43:22.6409062+00:00",
"Modified": "2025-04-04T02:43:22.6409062+00:00",
"Editor": "1ff99c17-1994-4e60-9d55-e78192820aae",
"PlannerTypeId": "51096c00-7a47-4d90-b31f-f686728532b4",
"ParentPlanId": "e9a3d7a0-3bb4-4b82-9f71-6fd494a6fefb",
"PortfolioParentId": "876c13b4-b791-4cd1-94e3-bf3f03469359",
"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": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
],
"LastComment": "2025-04-04T02:43:22.6409062+00:00",
"Integrations": [
{
"IntegrationId": "25d49d5e-bde5-4f3a-a465-a08663703dc4",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "5b19f5c8-fef8-4d3b-9fa9-a254f6c62bb5",
"LastExport": "2025-04-04T02:43:22.6409062+00:00",
"LastImport": "2025-04-04T02:43:22.6409062+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "25d49d5e-bde5-4f3a-a465-a08663703dc4",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "5b19f5c8-fef8-4d3b-9fa9-a254f6c62bb5",
"LastExport": "2025-04-04T02:43:22.6409062+00:00",
"LastImport": "2025-04-04T02:43:22.6409062+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-04-04T02:43:22.6409062+00:00",
"StatusReportId": "611cbb82-9188-45b1-8d9f-9832f7da19dd",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-04-04T02:43:22.6409062+00:00",
"StatusReportId": "611cbb82-9188-45b1-8d9f-9832f7da19dd",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"04c29cfd-d015-4bb2-8cc1-f521deda7465",
"1f5ef58d-bc67-4917-8ab1-f420f564c8de"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "bb207e6a-abe4-4787-bf4b-aa4b7d75a6d1",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:43:22.6409062+00:00",
"End": "2025-04-04T02:43:22.6409062+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:43:22.6409062+00:00",
"End": "2025-04-04T02:43:22.6409062+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "fcfa731e-2eaa-42ca-a27f-a28b473f75ed",
"BaseRate": 2.0
},
{
"ResourceId": "fcfa731e-2eaa-42ca-a27f-a28b473f75ed",
"BaseRate": 2.0
}
]
},
{
"Id": "bb207e6a-abe4-4787-bf4b-aa4b7d75a6d1",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:43:22.6409062+00:00",
"End": "2025-04-04T02:43:22.6409062+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:43:22.6409062+00:00",
"End": "2025-04-04T02:43:22.6409062+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "fcfa731e-2eaa-42ca-a27f-a28b473f75ed",
"BaseRate": 2.0
},
{
"ResourceId": "fcfa731e-2eaa-42ca-a27f-a28b473f75ed",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "38db3bfa-344f-4a1d-ace9-a2568cd82861",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "38db3bfa-344f-4a1d-ace9-a2568cd82861",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "f299ca70-da37-459d-9729-d87c27e54af0",
"LockedBy": "143fbcd6-0e41-4b8e-9682-8f1557d97816",
"LockedDate": "2025-04-04T02:43:22.6409062+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "15724b55-848a-4e7b-ac97-206e28e8e1da",
"CurrentGateId": "cdb716a7-48d7-4748-8f60-16b815f4090e",
"EnteredGate": "2025-04-04T02:43:22.6409062+00:00",
"ExitedGate": "2025-04-04T02:43:22.6409062+00:00",
"GateClosed": true,
"StepStarter": "591c1750-061c-4bc1-a81f-5d96879cd74f",
"StepApprover": "55f6c89b-c22b-4e6f-893a-f8ba2e60cd67",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "c30af2c7-c776-471b-9ac2-5433d50b39f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2b6ac9c2-c621-437a-9a2f-828893d64b10": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
},
"0ccc1248-3b45-4f96-bccf-beae77331a72": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
}
}
},
{
"StepId": "c30af2c7-c776-471b-9ac2-5433d50b39f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2b6ac9c2-c621-437a-9a2f-828893d64b10": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
},
"0ccc1248-3b45-4f96-bccf-beae77331a72": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "c30af2c7-c776-471b-9ac2-5433d50b39f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2b6ac9c2-c621-437a-9a2f-828893d64b10": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
},
"0ccc1248-3b45-4f96-bccf-beae77331a72": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
}
}
},
{
"StepId": "c30af2c7-c776-471b-9ac2-5433d50b39f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2b6ac9c2-c621-437a-9a2f-828893d64b10": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
},
"0ccc1248-3b45-4f96-bccf-beae77331a72": {
"TaskId": "98a301e7-9407-4978-b984-5c0a99c0ad0a",
"Status": 0,
"Comments": [
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
},
{
"Id": "41425cc4-6519-4f76-b1eb-7b9570abe718",
"UPN": "1ed7fc02-d27b-4917-b130-5a8186c7e41b",
"PostDate": "2025-04-04T02:43:22.6409062+00:00",
"Comment": "sample string 4",
"CC": [
"f3feaa28-bac7-4ed5-bcde-c252d97e4a2f",
"4fd0875d-12e3-4db9-b9fa-919d36579125"
],
"Users": [
"49101cd2-533d-4e46-8e25-2eb7f02be143",
"f2b474aa-9004-4155-88f2-d5ae377e2bc1"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "3944276a-f3ed-4b61-9ffc-53ae1d0d393c",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "3944276a-f3ed-4b61-9ffc-53ae1d0d393c",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "0bebd11e-5be3-4be2-af22-6724b5359737",
"ConfigId": "e98366a2-ae86-47bc-811e-121e4dbf9292"
}