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": "07113327-8ca2-49f7-93fd-04a13ce92e35",
"Created": "2025-09-03T18:04:15.4606359+00:00",
"Modified": "2025-09-03T18:04:15.4606359+00:00",
"Editor": "bbb89f8b-0491-4f8d-a357-73b8e0f51656",
"PlannerTypeId": "3a2018ef-b647-46a6-8840-9c4c35c4dce3",
"ParentPlanId": "c9df5f47-d3f9-492c-a3d8-f7b0a7f6cb00",
"PortfolioParentId": "1f034c09-3c60-42f9-8476-436bf7572dd6",
"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": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
],
"LastComment": "2025-09-03T18:04:15.4606359+00:00",
"Integrations": [
{
"IntegrationId": "0e74b808-b95f-4455-bdc5-e10e95386048",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "dbfeec8b-d8ff-48eb-882b-df2959164cd8",
"LastExport": "2025-09-03T18:04:15.4606359+00:00",
"LastImport": "2025-09-03T18:04:15.4606359+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "0e74b808-b95f-4455-bdc5-e10e95386048",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "dbfeec8b-d8ff-48eb-882b-df2959164cd8",
"LastExport": "2025-09-03T18:04:15.4606359+00:00",
"LastImport": "2025-09-03T18:04:15.4606359+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-09-03T18:04:15.4606359+00:00",
"StatusReportId": "053948f3-d47f-432d-98aa-c5a477f35cb8",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-09-03T18:04:15.4606359+00:00",
"StatusReportId": "053948f3-d47f-432d-98aa-c5a477f35cb8",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"506e5e6a-92f6-42e1-b71f-471e47cf6c26",
"f9df2c5d-62ad-45e4-9d7b-d2c7d0e5647d"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "166670f5-1b2e-44ad-a66c-54a060c76ce3",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-09-03T18:04:15.4606359+00:00",
"End": "2025-09-03T18:04:15.4606359+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-09-03T18:04:15.4606359+00:00",
"End": "2025-09-03T18:04:15.4606359+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "a43b492d-caef-480c-9bfa-2792e4b7438a",
"BaseRate": 2.0
},
{
"ResourceId": "a43b492d-caef-480c-9bfa-2792e4b7438a",
"BaseRate": 2.0
}
]
},
{
"Id": "166670f5-1b2e-44ad-a66c-54a060c76ce3",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-09-03T18:04:15.4606359+00:00",
"End": "2025-09-03T18:04:15.4606359+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-09-03T18:04:15.4606359+00:00",
"End": "2025-09-03T18:04:15.4606359+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "a43b492d-caef-480c-9bfa-2792e4b7438a",
"BaseRate": 2.0
},
{
"ResourceId": "a43b492d-caef-480c-9bfa-2792e4b7438a",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "b2fd0d72-d0c6-4b9f-ac16-4beb0559a985",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "b2fd0d72-d0c6-4b9f-ac16-4beb0559a985",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "22892235-2f3f-4774-9507-35afe1a55def",
"LockedBy": "12916de3-a628-4886-b365-5875b0e7deb1",
"LockedDate": "2025-09-03T18:04:15.4606359+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "7a111fc0-8950-428f-9612-ca7261f01d1b",
"CurrentGateId": "38462fc3-d215-4d65-9e2f-4beb3763d32c",
"EnteredGate": "2025-09-03T18:04:15.4606359+00:00",
"ExitedGate": "2025-09-03T18:04:15.4606359+00:00",
"GateClosed": true,
"StepStarter": "dcdf537d-6cae-4eb1-9390-44fbd966ea8c",
"StepApprover": "0e4d0b91-0bd3-4083-b68b-0c4592d298b0",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "52498c3f-d13a-421f-86be-ebc97ab759e3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"813f42be-096f-40fa-94ed-0ad97a633c36": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
},
"04cca9d0-4edf-4f25-97d2-51382a25b20d": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
}
}
},
{
"StepId": "52498c3f-d13a-421f-86be-ebc97ab759e3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"813f42be-096f-40fa-94ed-0ad97a633c36": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
},
"04cca9d0-4edf-4f25-97d2-51382a25b20d": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "52498c3f-d13a-421f-86be-ebc97ab759e3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"813f42be-096f-40fa-94ed-0ad97a633c36": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
},
"04cca9d0-4edf-4f25-97d2-51382a25b20d": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
}
}
},
{
"StepId": "52498c3f-d13a-421f-86be-ebc97ab759e3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"813f42be-096f-40fa-94ed-0ad97a633c36": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
},
"04cca9d0-4edf-4f25-97d2-51382a25b20d": {
"TaskId": "33ee2ac6-508e-402f-8d26-8827750068b5",
"Status": 0,
"Comments": [
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
},
{
"Id": "ddf78681-2677-4cc5-97b9-d7a857d00aec",
"UPN": "72b7d1ea-88db-4787-abc3-15431e5e5557",
"PostDate": "2025-09-03T18:04:15.4606359+00:00",
"Comment": "sample string 4",
"CC": [
"9be1f245-e224-4e45-8df0-91c54bdb525b",
"6fba3400-60e6-4332-9abe-cce9da971f21"
],
"Users": [
"8cd23894-fccc-41f1-9633-c01dda3aa81a",
"5e6bb69a-fb76-4cab-be6f-3441ab2b28cd"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5ae2d440-22f0-48aa-b674-dabc01631e59",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5ae2d440-22f0-48aa-b674-dabc01631e59",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "4eb4eb50-54ff-4216-82ac-541dbe7c6df3",
"ConfigId": "31c4ad06-52e3-4552-a60a-d4a9dd6f2235"
}