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": "289bb41b-eb67-4701-a3e5-4e0f431f671b",
"Created": "2025-12-03T13:05:57.1687258+00:00",
"Modified": "2025-12-03T13:05:57.1687258+00:00",
"Editor": "b34876dd-cc75-4483-831d-c01fc1987ac9",
"PlannerTypeId": "24e7421d-ecd5-4135-8eea-5cdf962c137e",
"ParentPlanId": "1d988939-7321-4d20-94a7-f1178eb9eee7",
"PortfolioParentId": "7f592531-caeb-45a0-bdc7-9f892701dc2b",
"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": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
],
"LastComment": "2025-12-03T13:05:57.1687258+00:00",
"Integrations": [
{
"IntegrationId": "4dd0cd85-8770-49a6-b018-82f11bf9c84d",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "89ee78eb-c3f8-415a-be25-0956f077b1d0",
"LastExport": "2025-12-03T13:05:57.1687258+00:00",
"LastImport": "2025-12-03T13:05:57.1687258+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "4dd0cd85-8770-49a6-b018-82f11bf9c84d",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "89ee78eb-c3f8-415a-be25-0956f077b1d0",
"LastExport": "2025-12-03T13:05:57.1687258+00:00",
"LastImport": "2025-12-03T13:05:57.1687258+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-12-03T13:05:57.1687258+00:00",
"StatusReportId": "ab0a76b5-ad59-4d6c-abb3-17fae075ad5e",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-12-03T13:05:57.1687258+00:00",
"StatusReportId": "ab0a76b5-ad59-4d6c-abb3-17fae075ad5e",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"b0c78718-f016-44ce-beb4-175e529b9a51",
"89194828-8676-4bc0-b6f9-7d4381b3ea3f"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "4d4a1ee4-0802-413d-938c-626c12806d6e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-12-03T13:05:57.1687258+00:00",
"End": "2025-12-03T13:05:57.1687258+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-12-03T13:05:57.1687258+00:00",
"End": "2025-12-03T13:05:57.1687258+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "42546f8f-2b66-4469-911b-ffb97635686a",
"BaseRate": 2.0
},
{
"ResourceId": "42546f8f-2b66-4469-911b-ffb97635686a",
"BaseRate": 2.0
}
]
},
{
"Id": "4d4a1ee4-0802-413d-938c-626c12806d6e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-12-03T13:05:57.1687258+00:00",
"End": "2025-12-03T13:05:57.1687258+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-12-03T13:05:57.1687258+00:00",
"End": "2025-12-03T13:05:57.1687258+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "42546f8f-2b66-4469-911b-ffb97635686a",
"BaseRate": 2.0
},
{
"ResourceId": "42546f8f-2b66-4469-911b-ffb97635686a",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "76b50e7d-6512-4b50-a158-22628b161d27",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "76b50e7d-6512-4b50-a158-22628b161d27",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "bb7da2f3-c654-45ab-993d-3862bfbee664",
"LockedBy": "5410359a-9aea-475b-91c1-7f66651171c0",
"LockedDate": "2025-12-03T13:05:57.1687258+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "801e7e9d-ae61-4d86-809f-d2aaca8f7337",
"CurrentGateId": "9dcb749b-a8df-4090-b924-827f9fe31304",
"EnteredGate": "2025-12-03T13:05:57.1687258+00:00",
"ExitedGate": "2025-12-03T13:05:57.1687258+00:00",
"GateClosed": true,
"StepStarter": "23dcd9fa-4c0a-4582-8468-b2c9169facb8",
"StepApprover": "4de8f691-72b2-4da3-8de6-492aa63803a9",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "fab86c84-4dc4-4910-b1d4-0d543d6b0ec5",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"255bbbd0-54cf-4180-9057-ebacb32a7f78": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
},
"90973941-61d0-4047-9d0a-9b42275ca928": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
}
}
},
{
"StepId": "fab86c84-4dc4-4910-b1d4-0d543d6b0ec5",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"255bbbd0-54cf-4180-9057-ebacb32a7f78": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
},
"90973941-61d0-4047-9d0a-9b42275ca928": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "fab86c84-4dc4-4910-b1d4-0d543d6b0ec5",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"255bbbd0-54cf-4180-9057-ebacb32a7f78": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
},
"90973941-61d0-4047-9d0a-9b42275ca928": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
}
}
},
{
"StepId": "fab86c84-4dc4-4910-b1d4-0d543d6b0ec5",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"255bbbd0-54cf-4180-9057-ebacb32a7f78": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
},
"90973941-61d0-4047-9d0a-9b42275ca928": {
"TaskId": "1b1e58b1-a2b0-4a00-bda7-0eeb88d4b895",
"Status": 0,
"Comments": [
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
},
{
"Id": "adda29ef-aaf6-4ddf-8341-5959f63ec044",
"UPN": "c6100c06-fbbf-4ad9-bc79-20d8512d99f5",
"PostDate": "2025-12-03T13:05:57.1687258+00:00",
"Comment": "sample string 4",
"CC": [
"e031f6ee-2dcf-46fa-be6c-08f735c4b3de",
"16241f7a-d7b9-40d2-91a5-4af899f2f994"
],
"Users": [
"26d42352-7a4e-40fc-b654-445372fb4b18",
"1289ef6b-846b-4d33-8c48-f8896c071eb8"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "a7ac10e4-c74a-424b-a5e0-1081d825c97b",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "a7ac10e4-c74a-424b-a5e0-1081d825c97b",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "643d49c6-8d44-4cd1-ae33-c22974762e94",
"ConfigId": "5d418caf-ce26-4b74-82a8-b66b994a1b3d"
}