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. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Archived": true,
"Author": "16e2e7b2-8e5a-4a93-96e9-6c661fc21ad9",
"Created": "2026-07-21T13:04:58.4092261+00:00",
"Modified": "2026-07-21T13:04:58.4092261+00:00",
"Editor": "f0970fa0-2e2b-4fda-bd01-f90979e9fba8",
"PlannerTypeId": "9824ae28-7425-4059-9539-05e12b45fe29",
"ParentPlanId": "4489cad3-34cf-4189-bba9-7e12992f4ea2",
"PortfolioParentId": "b8685a91-74bb-4c92-8f4f-0a9e88bf723c",
"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": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
],
"LastComment": "2026-07-21T13:04:58.4092261+00:00",
"Integrations": [
{
"IntegrationId": "315f5c1a-50ee-43a6-8fd3-e063ed24f537",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "c2db6d80-34e0-4e26-a806-82317883545a",
"LastExport": "2026-07-21T13:04:58.4092261+00:00",
"LastImport": "2026-07-21T13:04:58.4092261+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "315f5c1a-50ee-43a6-8fd3-e063ed24f537",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "c2db6d80-34e0-4e26-a806-82317883545a",
"LastExport": "2026-07-21T13:04:58.4092261+00:00",
"LastImport": "2026-07-21T13:04:58.4092261+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-21T13:04:58.4092261+00:00",
"StatusReportId": "dffa8220-548f-4179-b429-2d77f8969fad",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-21T13:04:58.4092261+00:00",
"StatusReportId": "dffa8220-548f-4179-b429-2d77f8969fad",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"92c8e69b-8d50-42cb-903e-bcc2ccefbde8",
"07ca1e75-49e2-498d-ba74-c1ead38da024"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "82e3ab1e-a2d0-4eba-a8f2-e851a50fe10d",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:04:58.4092261+00:00",
"End": "2026-07-21T13:04:58.4092261+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:04:58.4092261+00:00",
"End": "2026-07-21T13:04:58.4092261+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "c1e143e5-b7e4-41d5-aadf-adfdcb572012",
"BaseRate": 2.0
},
{
"ResourceId": "c1e143e5-b7e4-41d5-aadf-adfdcb572012",
"BaseRate": 2.0
}
]
},
{
"Id": "82e3ab1e-a2d0-4eba-a8f2-e851a50fe10d",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:04:58.4092261+00:00",
"End": "2026-07-21T13:04:58.4092261+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:04:58.4092261+00:00",
"End": "2026-07-21T13:04:58.4092261+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "c1e143e5-b7e4-41d5-aadf-adfdcb572012",
"BaseRate": 2.0
},
{
"ResourceId": "c1e143e5-b7e4-41d5-aadf-adfdcb572012",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "5b2769df-0b32-4de0-9cbe-efdbab53539e",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "5b2769df-0b32-4de0-9cbe-efdbab53539e",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "3b192d2b-35f2-450b-996e-126bb4443df0",
"LockedBy": "ec1885bc-7ddc-49db-b916-2bdab0afd3b7",
"LockedDate": "2026-07-21T13:04:58.4092261+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "a2e9bb36-e798-4006-a1c2-499fbdae9b79",
"CurrentGateId": "b5910ced-3fcb-45d3-8e65-cdcfc18d544f",
"EnteredGate": "2026-07-21T13:04:58.4092261+00:00",
"ExitedGate": "2026-07-21T13:04:58.4092261+00:00",
"GateClosed": true,
"StepStarter": "7c6b3c7a-d718-4624-9563-f84c854e103e",
"StepApprover": "6b7b6720-cf26-4b06-af3a-0216bcd38ad5",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "bf8aefd6-0332-4a39-9bea-3929589c545c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"166c6c7d-24df-46c4-96a8-a11e790712ae": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
},
"db199c84-2412-49c5-8bf8-f26d6ff91c65": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
}
}
},
{
"StepId": "bf8aefd6-0332-4a39-9bea-3929589c545c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"166c6c7d-24df-46c4-96a8-a11e790712ae": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
},
"db199c84-2412-49c5-8bf8-f26d6ff91c65": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "bf8aefd6-0332-4a39-9bea-3929589c545c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"166c6c7d-24df-46c4-96a8-a11e790712ae": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
},
"db199c84-2412-49c5-8bf8-f26d6ff91c65": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
}
}
},
{
"StepId": "bf8aefd6-0332-4a39-9bea-3929589c545c",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"166c6c7d-24df-46c4-96a8-a11e790712ae": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
},
"db199c84-2412-49c5-8bf8-f26d6ff91c65": {
"TaskId": "e597a3ef-fb35-40fe-a942-8a23d809e635",
"Status": 0,
"Comments": [
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
},
{
"Id": "907c5d20-b2d1-43f2-9d8a-3ef9568843ce",
"UPN": "f2addff1-972f-474b-9981-11dd0c7ee8f0",
"PostDate": "2026-07-21T13:04:58.4092261+00:00",
"Comment": "sample string 4",
"CC": [
"91fc293c-b9a0-4f85-b840-940be07ea50b",
"6549b9a0-fcfc-4345-a454-37c2ca636fd1"
],
"Users": [
"c7fb9036-1470-4c6f-b918-89235141acaf",
"d5c5c2c1-c9ec-4218-99db-467d45621852"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "d5fbdb01-5a3b-47e5-8d3e-ceb3ba808e06",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "d5fbdb01-5a3b-47e5-8d3e-ceb3ba808e06",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "d28392a5-d704-4a7d-98c6-793ddd235a88",
"ConfigId": "c73680e6-e0e9-4564-95b9-fd471248dfe2"
}