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": "9d0cbcd6-2350-44f6-8713-69e350886a5b",
"Created": "2026-05-02T16:44:22.2337681+00:00",
"Modified": "2026-05-02T16:44:22.2337681+00:00",
"Editor": "fcc2fd9f-5e96-4d1f-90e3-f2f6dc581c66",
"PlannerTypeId": "2102ad81-4990-42e0-b28b-c1636a16efda",
"ParentPlanId": "9793e501-e0a4-4fbe-9196-adf51b7bca5b",
"PortfolioParentId": "722ea05e-4ad7-4a1f-ab42-f5e810f7a462",
"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": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
],
"LastComment": "2026-05-02T16:44:22.2337681+00:00",
"Integrations": [
{
"IntegrationId": "c4ea6e6b-d685-4302-9a92-ddcd61cfcf59",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "da281c85-1613-4825-89a9-3d23d5a71b96",
"LastExport": "2026-05-02T16:44:22.2337681+00:00",
"LastImport": "2026-05-02T16:44:22.2337681+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "c4ea6e6b-d685-4302-9a92-ddcd61cfcf59",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "da281c85-1613-4825-89a9-3d23d5a71b96",
"LastExport": "2026-05-02T16:44:22.2337681+00:00",
"LastImport": "2026-05-02T16:44:22.2337681+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-05-02T16:44:22.2337681+00:00",
"StatusReportId": "1fe9732e-1fec-4508-8840-d108a702385b",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-05-02T16:44:22.2337681+00:00",
"StatusReportId": "1fe9732e-1fec-4508-8840-d108a702385b",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"06286007-ad5e-480f-9af8-d735be18351c",
"558dc7b9-652e-4b72-ada6-1fb401117180"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "65d0eac1-5f02-4859-a59a-f42494bece95",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-05-02T16:44:22.2337681+00:00",
"End": "2026-05-02T16:44:22.2337681+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-05-02T16:44:22.2337681+00:00",
"End": "2026-05-02T16:44:22.2337681+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "36a6cdfa-378a-4353-b003-d5ca10fcc4d2",
"BaseRate": 2.0
},
{
"ResourceId": "36a6cdfa-378a-4353-b003-d5ca10fcc4d2",
"BaseRate": 2.0
}
]
},
{
"Id": "65d0eac1-5f02-4859-a59a-f42494bece95",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-05-02T16:44:22.2337681+00:00",
"End": "2026-05-02T16:44:22.2337681+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-05-02T16:44:22.2337681+00:00",
"End": "2026-05-02T16:44:22.2337681+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "36a6cdfa-378a-4353-b003-d5ca10fcc4d2",
"BaseRate": 2.0
},
{
"ResourceId": "36a6cdfa-378a-4353-b003-d5ca10fcc4d2",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "2b4791af-f92a-4f03-8b6c-1627dd341849",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "2b4791af-f92a-4f03-8b6c-1627dd341849",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "928c25e8-3269-4b9a-9391-5887bef96deb",
"LockedBy": "ed538682-d127-4e50-845b-dbcaa651402d",
"LockedDate": "2026-05-02T16:44:22.2337681+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "fe30c9d5-b1c8-49f8-a2a7-2bc88433e1c5",
"CurrentGateId": "ffa4b824-7170-4c33-a8c7-0766f5ed3bc6",
"EnteredGate": "2026-05-02T16:44:22.2337681+00:00",
"ExitedGate": "2026-05-02T16:44:22.2337681+00:00",
"GateClosed": true,
"StepStarter": "3057e689-4589-4e84-8768-bdcbaa632838",
"StepApprover": "c9b27a43-85d8-4584-8069-8353259ced09",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "210feed1-2b7a-4adc-8665-06d862f5751a",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59698363-d784-4a14-a4c3-0fbae976d9da": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
},
"85e8cf93-0ea4-4173-95f5-7db25f60824b": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
}
}
},
{
"StepId": "210feed1-2b7a-4adc-8665-06d862f5751a",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59698363-d784-4a14-a4c3-0fbae976d9da": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
},
"85e8cf93-0ea4-4173-95f5-7db25f60824b": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "210feed1-2b7a-4adc-8665-06d862f5751a",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59698363-d784-4a14-a4c3-0fbae976d9da": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
},
"85e8cf93-0ea4-4173-95f5-7db25f60824b": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
}
}
},
{
"StepId": "210feed1-2b7a-4adc-8665-06d862f5751a",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"59698363-d784-4a14-a4c3-0fbae976d9da": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
},
"85e8cf93-0ea4-4173-95f5-7db25f60824b": {
"TaskId": "4f76bd8b-58da-4bb1-b2f2-874433b2c28c",
"Status": 0,
"Comments": [
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
},
{
"Id": "299dc60e-483b-440e-a5c7-ff87ee208958",
"UPN": "9ef74a78-33f0-48b4-b8d5-0fddbd6e5b37",
"PostDate": "2026-05-02T16:44:22.2337681+00:00",
"Comment": "sample string 4",
"CC": [
"1114feb9-aba4-43c1-b5bb-c56f5aca8721",
"0dd02aad-5de8-4639-93e4-aaebffa65101"
],
"Users": [
"0c50d6b4-cae8-4308-9d42-d5aa2dca9e65",
"c111f20a-2c3f-4a8f-b08e-d7915d03af7d"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "35e68377-c272-4338-985b-41e62da65f6a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "35e68377-c272-4338-985b-41e62da65f6a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "bcdd1397-a6fe-4996-b526-0e3cc6bb017b",
"ConfigId": "31339be3-3a1a-4d01-92d2-4eae7c5a2192"
}