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": "c3361400-c27d-4f81-b3af-a19c4b61093e",
"Created": "2025-07-16T12:34:48.1768804+00:00",
"Modified": "2025-07-16T12:34:48.1768804+00:00",
"Editor": "2610c4e1-a50b-4ebc-9dfc-30b96841ce98",
"PlannerTypeId": "06ac74d6-126b-496c-a886-eb7981713114",
"ParentPlanId": "3563a438-a8cd-4e99-8a54-75ec60082294",
"PortfolioParentId": "3b3ebb67-6d15-4650-8ce3-34eee2f8a315",
"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": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
],
"LastComment": "2025-07-16T12:34:48.1768804+00:00",
"Integrations": [
{
"IntegrationId": "23becd43-76f9-4d04-ba81-631e1c979e52",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "9fd49201-aa54-413c-aa7d-ae42573bdc4e",
"LastExport": "2025-07-16T12:34:48.1768804+00:00",
"LastImport": "2025-07-16T12:34:48.1768804+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "23becd43-76f9-4d04-ba81-631e1c979e52",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "9fd49201-aa54-413c-aa7d-ae42573bdc4e",
"LastExport": "2025-07-16T12:34:48.1768804+00:00",
"LastImport": "2025-07-16T12:34:48.1768804+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-16T12:34:48.1768804+00:00",
"StatusReportId": "33988827-925e-4299-b22d-6cc3198e79d5",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-16T12:34:48.1768804+00:00",
"StatusReportId": "33988827-925e-4299-b22d-6cc3198e79d5",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"03d02c21-f5ad-4393-88b1-0610fffedd21",
"3178c5fc-27e4-4462-ae9c-a8bb36053d16"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "90619bec-43dd-4ee5-81be-88d57528f02e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-16T12:34:48.1768804+00:00",
"End": "2025-07-16T12:34:48.1768804+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-16T12:34:48.1768804+00:00",
"End": "2025-07-16T12:34:48.1768804+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "0a067f8d-1188-401d-97de-0c81391057da",
"BaseRate": 2.0
},
{
"ResourceId": "0a067f8d-1188-401d-97de-0c81391057da",
"BaseRate": 2.0
}
]
},
{
"Id": "90619bec-43dd-4ee5-81be-88d57528f02e",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-16T12:34:48.1768804+00:00",
"End": "2025-07-16T12:34:48.1768804+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-16T12:34:48.1768804+00:00",
"End": "2025-07-16T12:34:48.1768804+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "0a067f8d-1188-401d-97de-0c81391057da",
"BaseRate": 2.0
},
{
"ResourceId": "0a067f8d-1188-401d-97de-0c81391057da",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "529ebd38-40e6-4d0a-9b0c-a799d8264c94",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "529ebd38-40e6-4d0a-9b0c-a799d8264c94",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "d88fe4e8-3130-4913-b6c8-a15dfafad81b",
"LockedBy": "8d64ce9d-c11e-40c9-9542-57fc543d978f",
"LockedDate": "2025-07-16T12:34:48.1768804+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "7f75e8f6-1aef-442a-8e85-3a2de54bd45f",
"CurrentGateId": "22fced3a-e243-44c8-a954-9589ab23d4a2",
"EnteredGate": "2025-07-16T12:34:48.1768804+00:00",
"ExitedGate": "2025-07-16T12:34:48.1768804+00:00",
"GateClosed": true,
"StepStarter": "b716cc13-9960-4398-a702-6449d0147cf1",
"StepApprover": "ebb82e4b-104e-4daf-ae81-ddd0b7944cf0",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "826a4d76-33c0-429b-87bb-7689bb0504ba",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"65c0903f-eba8-4b43-a7ae-6726b2c3efdb": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
},
"0919827f-2ced-41f5-935d-5cde082d9cc9": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
}
}
},
{
"StepId": "826a4d76-33c0-429b-87bb-7689bb0504ba",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"65c0903f-eba8-4b43-a7ae-6726b2c3efdb": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
},
"0919827f-2ced-41f5-935d-5cde082d9cc9": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "826a4d76-33c0-429b-87bb-7689bb0504ba",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"65c0903f-eba8-4b43-a7ae-6726b2c3efdb": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
},
"0919827f-2ced-41f5-935d-5cde082d9cc9": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
}
}
},
{
"StepId": "826a4d76-33c0-429b-87bb-7689bb0504ba",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"65c0903f-eba8-4b43-a7ae-6726b2c3efdb": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
},
"0919827f-2ced-41f5-935d-5cde082d9cc9": {
"TaskId": "3a23cca2-52ce-4cba-8ab2-3d51185046f1",
"Status": 0,
"Comments": [
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
},
{
"Id": "dc8f562a-08ec-43cf-9b43-46270e1c2374",
"UPN": "a15abe8b-591e-4c2a-b8e5-f60082b41b37",
"PostDate": "2025-07-16T12:34:48.1768804+00:00",
"Comment": "sample string 4",
"CC": [
"50e4a0ee-6709-4ab6-a125-3765bcfae627",
"b503dfb4-ee90-4b20-884c-767ac42be0df"
],
"Users": [
"8671ebf1-3965-4821-b8dd-502ae1a4e7d2",
"7c1b5497-0488-4efb-a7f0-aa380ebfde02"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "1668f3a2-bb84-463f-8bc7-c8af88d249f8",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "1668f3a2-bb84-463f-8bc7-c8af88d249f8",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "4fe3c65a-9b54-4b86-82d0-00effad0bba2",
"ConfigId": "d2a24eeb-7e34-4951-b4d6-32d25b82da1a"
}