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": "735a305a-16ac-4049-8997-a285cc340f50",
"Created": "2025-10-19T09:09:55.9138752+00:00",
"Modified": "2025-10-19T09:09:55.9138752+00:00",
"Editor": "d630339c-17f7-48c0-b9d5-c2e44e080f33",
"PlannerTypeId": "875c61f3-7b1b-4350-a3f9-8b4d40cb7758",
"ParentPlanId": "c7075354-db34-48fc-a620-ab4a946c041b",
"PortfolioParentId": "67a7d591-1f12-446a-b402-7adbc556965c",
"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": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
],
"LastComment": "2025-10-19T09:09:55.9138752+00:00",
"Integrations": [
{
"IntegrationId": "abd18afc-5511-46ca-a378-d574c33ab079",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e7305dff-bbf3-47e1-bf7d-43e75f2525fc",
"LastExport": "2025-10-19T09:09:55.9138752+00:00",
"LastImport": "2025-10-19T09:09:55.9138752+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "abd18afc-5511-46ca-a378-d574c33ab079",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e7305dff-bbf3-47e1-bf7d-43e75f2525fc",
"LastExport": "2025-10-19T09:09:55.9138752+00:00",
"LastImport": "2025-10-19T09:09:55.9138752+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-10-19T09:09:55.9138752+00:00",
"StatusReportId": "8ecdfe4e-7aea-43b8-bad0-6af846578f01",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-10-19T09:09:55.9138752+00:00",
"StatusReportId": "8ecdfe4e-7aea-43b8-bad0-6af846578f01",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"cd1f1877-d19a-4502-8ee5-5dfcf14390e3",
"d576d36d-a4e0-4033-b1d7-4e3bd365308c"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "3e531328-7693-47cb-b79b-6617cf79c420",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-19T09:09:55.9138752+00:00",
"End": "2025-10-19T09:09:55.9138752+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-19T09:09:55.9138752+00:00",
"End": "2025-10-19T09:09:55.9138752+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "cc896892-9588-4db7-8d7c-dbf5302e4f3c",
"BaseRate": 2.0
},
{
"ResourceId": "cc896892-9588-4db7-8d7c-dbf5302e4f3c",
"BaseRate": 2.0
}
]
},
{
"Id": "3e531328-7693-47cb-b79b-6617cf79c420",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-19T09:09:55.9138752+00:00",
"End": "2025-10-19T09:09:55.9138752+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-19T09:09:55.9138752+00:00",
"End": "2025-10-19T09:09:55.9138752+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "cc896892-9588-4db7-8d7c-dbf5302e4f3c",
"BaseRate": 2.0
},
{
"ResourceId": "cc896892-9588-4db7-8d7c-dbf5302e4f3c",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "ce1fe717-3239-41f2-825e-c817d31ad305",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "ce1fe717-3239-41f2-825e-c817d31ad305",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "bc6b726a-3d4f-4151-a0c4-87da143ce7dc",
"LockedBy": "8c42c709-2970-4111-95be-90b790d8eea5",
"LockedDate": "2025-10-19T09:09:55.9138752+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "30393653-d44d-40a9-97c7-4b02e490771e",
"CurrentGateId": "98d604c7-f3ad-434f-9735-36f91b57e46c",
"EnteredGate": "2025-10-19T09:09:55.9138752+00:00",
"ExitedGate": "2025-10-19T09:09:55.9138752+00:00",
"GateClosed": true,
"StepStarter": "a978fb00-8d51-4016-ae77-6484e3cc6c1f",
"StepApprover": "0aa0e6d8-23c0-4cd9-a9a5-595e6ad872a6",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "3e8f0f85-be31-4b2f-9d73-4d242596d515",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59b5bc48-0db3-452f-a7b6-7acf2ce94d90": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
},
"554b9402-1047-45c9-90a5-504bb798ed2f": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
}
}
},
{
"StepId": "3e8f0f85-be31-4b2f-9d73-4d242596d515",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59b5bc48-0db3-452f-a7b6-7acf2ce94d90": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
},
"554b9402-1047-45c9-90a5-504bb798ed2f": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "3e8f0f85-be31-4b2f-9d73-4d242596d515",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59b5bc48-0db3-452f-a7b6-7acf2ce94d90": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
},
"554b9402-1047-45c9-90a5-504bb798ed2f": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
}
}
},
{
"StepId": "3e8f0f85-be31-4b2f-9d73-4d242596d515",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59b5bc48-0db3-452f-a7b6-7acf2ce94d90": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
},
"554b9402-1047-45c9-90a5-504bb798ed2f": {
"TaskId": "ca424f6c-13ce-4e43-9cc6-56010e83d185",
"Status": 0,
"Comments": [
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
},
{
"Id": "fbaf5dde-ab0f-4601-905b-e1fa0c824562",
"UPN": "5b35569e-bc8a-4c68-9b22-5f7f023b430a",
"PostDate": "2025-10-19T09:09:55.9138752+00:00",
"Comment": "sample string 4",
"CC": [
"f6ce48c3-01fc-4d13-9012-4fd5d20ca06d",
"a190c3f0-c933-4768-8d5e-2763803aaa40"
],
"Users": [
"28c9d7d0-4c10-43cd-9842-26c4f204e4c1",
"0b5a2bc8-889c-4f41-b6f1-193b93a38b4c"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "edb9ff4d-6c6d-47e5-85ec-747177c7b0f0",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "edb9ff4d-6c6d-47e5-85ec-747177c7b0f0",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "5c0f6880-82f0-4bc3-87ff-d9783a76c1c9",
"ConfigId": "efcf8406-4677-4a1f-9d71-ac44347c9006"
}