POST api/workplan/{PlanId}/step?StepName={StepName}&StepId={StepId}
Update Process Step
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PlanId | globally unique identifier |
Required |
|
| StepName | string |
Default value is |
|
| StepId | globally unique identifier |
None. |
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": "8179a5d0-c8d5-4ced-a587-abf3575448d3",
"Created": "2026-09-29T19:19:09.5757437+00:00",
"Modified": "2026-09-29T19:19:09.5757437+00:00",
"Editor": "f1567821-acd1-4927-a840-7669e1f7e07e",
"PlannerTypeId": "70370c52-28be-4acc-bea7-7f6e13478941",
"ParentPlanId": "3e700ec6-04a7-4812-92df-ecddb1fe77b9",
"PortfolioParentId": "7a2062a7-a909-4223-8466-92af03358459",
"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": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
],
"LastComment": "2026-09-29T19:19:09.5757437+00:00",
"Integrations": [
{
"IntegrationId": "bd0fa58c-f35b-42ec-b4c4-b2004011a015",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "742a9ef0-61ff-417d-b736-e265269a50fe",
"LastExport": "2026-09-29T19:19:09.5757437+00:00",
"LastImport": "2026-09-29T19:19:09.5757437+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "bd0fa58c-f35b-42ec-b4c4-b2004011a015",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "742a9ef0-61ff-417d-b736-e265269a50fe",
"LastExport": "2026-09-29T19:19:09.5757437+00:00",
"LastImport": "2026-09-29T19:19:09.5757437+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-09-29T19:19:09.5757437+00:00",
"StatusReportId": "2f5aa22d-db66-4b9f-8204-c758bb594e97",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-09-29T19:19:09.5757437+00:00",
"StatusReportId": "2f5aa22d-db66-4b9f-8204-c758bb594e97",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"c5099df0-4697-4541-accf-b7931f0babe5",
"44ad0df6-bda3-401d-b214-08aae5065e6b"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "e188f3f0-e342-4912-bc2b-913e7c65855c",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:19:09.5757437+00:00",
"End": "2026-09-29T19:19:09.5757437+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:19:09.5757437+00:00",
"End": "2026-09-29T19:19:09.5757437+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "d874a876-956c-49d0-bbc8-935dfdcb028a",
"BaseRate": 2.0
},
{
"ResourceId": "d874a876-956c-49d0-bbc8-935dfdcb028a",
"BaseRate": 2.0
}
]
},
{
"Id": "e188f3f0-e342-4912-bc2b-913e7c65855c",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:19:09.5757437+00:00",
"End": "2026-09-29T19:19:09.5757437+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:19:09.5757437+00:00",
"End": "2026-09-29T19:19:09.5757437+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "d874a876-956c-49d0-bbc8-935dfdcb028a",
"BaseRate": 2.0
},
{
"ResourceId": "d874a876-956c-49d0-bbc8-935dfdcb028a",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "d5b6206f-89ce-41e0-9b69-b41dc0032581",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "d5b6206f-89ce-41e0-9b69-b41dc0032581",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "3155a9d9-6851-46a1-806e-73dc855b655a",
"LockedBy": "7598c74e-a140-4eac-9f2f-aca93a3aed27",
"LockedDate": "2026-09-29T19:19:09.5757437+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "0c9b7b99-7808-4edb-9bce-51483027db3f",
"CurrentGateId": "37b3df4d-1621-41a3-a3d2-77bdebc47364",
"EnteredGate": "2026-09-29T19:19:09.5757437+00:00",
"ExitedGate": "2026-09-29T19:19:09.5757437+00:00",
"GateClosed": true,
"StepStarter": "0ee0b40f-6e66-4790-84ea-66d09579a2a5",
"StepApprover": "dd061414-ff51-438d-865c-511ccf3072aa",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "9029412a-8c66-4abb-a0ba-21bd2b65761b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"696957d1-1750-4dee-9da7-c9431fe99ec3": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
},
"f8c96dc5-8b2b-4987-9377-79c889ce38a0": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
}
}
},
{
"StepId": "9029412a-8c66-4abb-a0ba-21bd2b65761b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"696957d1-1750-4dee-9da7-c9431fe99ec3": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
},
"f8c96dc5-8b2b-4987-9377-79c889ce38a0": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "9029412a-8c66-4abb-a0ba-21bd2b65761b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"696957d1-1750-4dee-9da7-c9431fe99ec3": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
},
"f8c96dc5-8b2b-4987-9377-79c889ce38a0": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
}
}
},
{
"StepId": "9029412a-8c66-4abb-a0ba-21bd2b65761b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"696957d1-1750-4dee-9da7-c9431fe99ec3": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
},
"f8c96dc5-8b2b-4987-9377-79c889ce38a0": {
"TaskId": "4f844c06-8cb5-4a26-b984-d6003d034b2f",
"Status": 0,
"Comments": [
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
},
{
"Id": "8b9ab3d5-dbdf-4bac-bf25-e37983f2c7b0",
"UPN": "c31bfcfa-dc7d-47ee-bb37-f08b81a5b850",
"PostDate": "2026-09-29T19:19:09.5757437+00:00",
"Comment": "sample string 4",
"CC": [
"3cea808e-3434-4826-89a1-8a9a0aedea0c",
"57f5c22c-7b86-4d7b-b1af-eb40f373e689"
],
"Users": [
"99f6097e-6b37-40a4-ba79-89214c193b19",
"0a1ef972-817b-476b-9d2c-de0ca93b84c2"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "cc298f34-9a89-4338-8413-01561e569993",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "cc298f34-9a89-4338-8413-01561e569993",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"IsPrivate": true,
"id": "7706e334-745a-4412-aeca-54121228b09a",
"ConfigId": "cb01f0da-a4e2-4f08-a9f9-90326515ce11"
}