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": "8f870b1b-9f97-4672-9ff9-2f8491245754",
"Created": "2026-07-01T16:17:17.1439703+00:00",
"Modified": "2026-07-01T16:17:17.1439703+00:00",
"Editor": "8289015e-bd17-4a52-96d1-a527ba1aac79",
"PlannerTypeId": "322c73b3-cbcf-483b-aa09-10d2f8b52b5f",
"ParentPlanId": "8e41604a-f970-4160-93ff-252d574fd980",
"PortfolioParentId": "3cd31b6c-8802-4b02-beff-1145c6b31995",
"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": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
],
"LastComment": "2026-07-01T16:17:17.1439703+00:00",
"Integrations": [
{
"IntegrationId": "b859f69f-aa79-4ffb-a487-107a5cf8bdde",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "07195f12-6167-4b48-b9ec-bc3e49c4eae0",
"LastExport": "2026-07-01T16:17:17.1439703+00:00",
"LastImport": "2026-07-01T16:17:17.1439703+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "b859f69f-aa79-4ffb-a487-107a5cf8bdde",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "07195f12-6167-4b48-b9ec-bc3e49c4eae0",
"LastExport": "2026-07-01T16:17:17.1439703+00:00",
"LastImport": "2026-07-01T16:17:17.1439703+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-01T16:17:17.1439703+00:00",
"StatusReportId": "63892e11-7c56-44e0-9cf4-4c76acf9ffc6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-01T16:17:17.1439703+00:00",
"StatusReportId": "63892e11-7c56-44e0-9cf4-4c76acf9ffc6",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"8ffd4fd7-c9a1-4d8f-827d-0a507ed437a0",
"6a8815ce-bf07-4cbc-ac9c-db49866578b9"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "59b9af39-d0f4-4478-89dd-efd10c2e954f",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:17:17.1439703+00:00",
"End": "2026-07-01T16:17:17.1439703+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:17:17.1439703+00:00",
"End": "2026-07-01T16:17:17.1439703+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "1bcf8d8b-c871-409d-8406-c3593a146291",
"BaseRate": 2.0
},
{
"ResourceId": "1bcf8d8b-c871-409d-8406-c3593a146291",
"BaseRate": 2.0
}
]
},
{
"Id": "59b9af39-d0f4-4478-89dd-efd10c2e954f",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:17:17.1439703+00:00",
"End": "2026-07-01T16:17:17.1439703+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:17:17.1439703+00:00",
"End": "2026-07-01T16:17:17.1439703+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "1bcf8d8b-c871-409d-8406-c3593a146291",
"BaseRate": 2.0
},
{
"ResourceId": "1bcf8d8b-c871-409d-8406-c3593a146291",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "26e5a624-e71b-406c-9282-ed6eb5d8ef90",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "26e5a624-e71b-406c-9282-ed6eb5d8ef90",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "2fec1497-8c19-43bd-b456-216c2b1005c1",
"LockedBy": "d1bf7387-0426-4b5a-b27b-04476f3565e0",
"LockedDate": "2026-07-01T16:17:17.1439703+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "dbeb5eee-b3aa-42b3-abd6-e8011d32c926",
"CurrentGateId": "09a9395d-5ef6-4869-8c15-fffaa1dd4203",
"EnteredGate": "2026-07-01T16:17:17.1439703+00:00",
"ExitedGate": "2026-07-01T16:17:17.1439703+00:00",
"GateClosed": true,
"StepStarter": "def42888-d0ef-41dd-972b-2a07bbbc04c1",
"StepApprover": "53c9218e-e50e-4222-9db0-b8f91cec74bf",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "b74e0df5-d4bb-4861-ae76-1b4ea27a2a31",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dfd9486-d249-4def-8940-0188a09587ac": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
},
"08e56ab4-ca5a-4307-95d2-73cba0eaea51": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
}
}
},
{
"StepId": "b74e0df5-d4bb-4861-ae76-1b4ea27a2a31",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dfd9486-d249-4def-8940-0188a09587ac": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
},
"08e56ab4-ca5a-4307-95d2-73cba0eaea51": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "b74e0df5-d4bb-4861-ae76-1b4ea27a2a31",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dfd9486-d249-4def-8940-0188a09587ac": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
},
"08e56ab4-ca5a-4307-95d2-73cba0eaea51": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
}
}
},
{
"StepId": "b74e0df5-d4bb-4861-ae76-1b4ea27a2a31",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7dfd9486-d249-4def-8940-0188a09587ac": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
},
"08e56ab4-ca5a-4307-95d2-73cba0eaea51": {
"TaskId": "dfa13339-1e9c-4013-9756-9aea008c113d",
"Status": 0,
"Comments": [
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
},
{
"Id": "8c74b611-3bfd-4228-b204-cb1666ff3024",
"UPN": "559f9655-abf8-49fc-8107-ea32b13a1fd8",
"PostDate": "2026-07-01T16:17:17.1439703+00:00",
"Comment": "sample string 4",
"CC": [
"8744febe-0a02-4e03-a84e-7a1be89b096b",
"e9b8ed90-94ed-45b2-8f07-629c3a57008b"
],
"Users": [
"f0150c59-4f8e-4afb-9274-9323bda81b85",
"29f3306e-d1c5-47d2-96f2-e4ae97fa1a49"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5665e216-be7f-4bb4-bb82-844d2326a61d",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5665e216-be7f-4bb4-bb82-844d2326a61d",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "bd87e7e1-887f-4a15-b056-ba7a1d51a6d0",
"ConfigId": "556b4b9a-8338-4a5e-b875-924036d88f96"
}