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": "004354e2-7799-43f4-8abd-1c705c81f2bb",
"Created": "2026-06-05T16:20:55.3621578+00:00",
"Modified": "2026-06-05T16:20:55.3621578+00:00",
"Editor": "5f8968cb-1730-4cb9-b923-ec87c33b3390",
"PlannerTypeId": "74e109f6-3e0f-422f-9ecd-56327629811d",
"ParentPlanId": "92e02b0a-9151-4788-8a44-dd154e332c72",
"PortfolioParentId": "ffb48f30-5f37-462a-9c11-bcc556c524b9",
"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": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
],
"LastComment": "2026-06-05T16:20:55.3621578+00:00",
"Integrations": [
{
"IntegrationId": "934607e1-89f3-4462-b873-3ff9ad87eef5",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "32fb8a17-1052-4119-bbf5-d4ef535680a0",
"LastExport": "2026-06-05T16:20:55.3621578+00:00",
"LastImport": "2026-06-05T16:20:55.3621578+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "934607e1-89f3-4462-b873-3ff9ad87eef5",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "32fb8a17-1052-4119-bbf5-d4ef535680a0",
"LastExport": "2026-06-05T16:20:55.3621578+00:00",
"LastImport": "2026-06-05T16:20:55.3621578+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-06-05T16:20:55.3621578+00:00",
"StatusReportId": "73729969-fc36-4970-85f7-c0d9534244d5",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-06-05T16:20:55.3621578+00:00",
"StatusReportId": "73729969-fc36-4970-85f7-c0d9534244d5",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"e11fdf9c-3a2c-43c3-87eb-e08e310bbcab",
"439cdf79-4ef9-440a-bf65-76ddc52199ea"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "82513bfe-d658-4090-b415-c0b1fcb694b2",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-06-05T16:20:55.3621578+00:00",
"End": "2026-06-05T16:20:55.3621578+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-06-05T16:20:55.3621578+00:00",
"End": "2026-06-05T16:20:55.3621578+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "0c9beaac-aee8-4dde-a9f0-d8667ba1cb14",
"BaseRate": 2.0
},
{
"ResourceId": "0c9beaac-aee8-4dde-a9f0-d8667ba1cb14",
"BaseRate": 2.0
}
]
},
{
"Id": "82513bfe-d658-4090-b415-c0b1fcb694b2",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-06-05T16:20:55.3621578+00:00",
"End": "2026-06-05T16:20:55.3621578+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-06-05T16:20:55.3621578+00:00",
"End": "2026-06-05T16:20:55.3621578+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "0c9beaac-aee8-4dde-a9f0-d8667ba1cb14",
"BaseRate": 2.0
},
{
"ResourceId": "0c9beaac-aee8-4dde-a9f0-d8667ba1cb14",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "a6f88ef2-d2bc-44f2-83a5-8dd719d6142b",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "a6f88ef2-d2bc-44f2-83a5-8dd719d6142b",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "efd15300-226f-4408-9bae-3c56171a0dea",
"LockedBy": "8809170a-e8ac-411b-982d-161cfdcfdf72",
"LockedDate": "2026-06-05T16:20:55.3621578+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "6f54d76c-eaea-462b-931d-2c6c623a8a9f",
"CurrentGateId": "5f944003-ffd0-479c-acbd-3014b783639f",
"EnteredGate": "2026-06-05T16:20:55.3621578+00:00",
"ExitedGate": "2026-06-05T16:20:55.3621578+00:00",
"GateClosed": true,
"StepStarter": "3c8ac46a-5597-419b-86f3-74dbbd5f5704",
"StepApprover": "f4c4becb-cc38-46ce-99f3-eed6a5fad950",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "c923e761-c4ba-4812-9f9f-a5508f281216",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"f39f8f51-5104-4563-b984-1c3c9569ef3f": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
},
"86da0acc-dfc1-4670-b72d-d5f502dba651": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
}
}
},
{
"StepId": "c923e761-c4ba-4812-9f9f-a5508f281216",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"f39f8f51-5104-4563-b984-1c3c9569ef3f": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
},
"86da0acc-dfc1-4670-b72d-d5f502dba651": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "c923e761-c4ba-4812-9f9f-a5508f281216",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"f39f8f51-5104-4563-b984-1c3c9569ef3f": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
},
"86da0acc-dfc1-4670-b72d-d5f502dba651": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
}
}
},
{
"StepId": "c923e761-c4ba-4812-9f9f-a5508f281216",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"f39f8f51-5104-4563-b984-1c3c9569ef3f": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
},
"86da0acc-dfc1-4670-b72d-d5f502dba651": {
"TaskId": "4bd4f304-ccb8-4286-a69d-a8736dffefdf",
"Status": 0,
"Comments": [
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
},
{
"Id": "ad3c1b33-e2a1-40ef-b3a1-b28522f8283a",
"UPN": "9a343184-d92c-461b-b3a0-c663d42047a8",
"PostDate": "2026-06-05T16:20:55.3621578+00:00",
"Comment": "sample string 4",
"CC": [
"2d222cf8-8499-4be9-834f-7e7d051329a1",
"b99ea736-4e57-47d1-bf98-2ab3abdab5d7"
],
"Users": [
"e5e54010-ab12-4d10-93e2-02d12fbab1b6",
"a1f01155-bb85-42f1-9fea-84d78ac857ce"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "25f7cecb-0c0e-4ce6-8841-88ea86f9d32a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "25f7cecb-0c0e-4ce6-8841-88ea86f9d32a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "78705600-700e-4946-9f8a-338acaf2fff3",
"ConfigId": "fcede7f8-6054-4d5b-aca1-0b7f291cef80"
}