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": "2471b719-b7b1-4a9d-9ff2-6c0dc3e31153",
"Created": "2025-05-23T21:19:38.7771172+00:00",
"Modified": "2025-05-23T21:19:38.7771172+00:00",
"Editor": "69a0f206-db52-440c-a4b1-30bf5416d23e",
"PlannerTypeId": "644322dc-cb4f-4f36-bc63-299ce7530d33",
"ParentPlanId": "a464b5c8-89c2-417f-80a3-e3dcbaf63b6a",
"PortfolioParentId": "21a9b7d3-9efc-4ce2-8547-bd81c47c7c05",
"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": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
],
"LastComment": "2025-05-23T21:19:38.7771172+00:00",
"Integrations": [
{
"IntegrationId": "b352bfa8-8915-40b6-9d96-980cfdfa23cb",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1ca4af8d-264c-40cc-a2c3-d9c3c63c55e6",
"LastExport": "2025-05-23T21:19:38.7927441+00:00",
"LastImport": "2025-05-23T21:19:38.7927441+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "b352bfa8-8915-40b6-9d96-980cfdfa23cb",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1ca4af8d-264c-40cc-a2c3-d9c3c63c55e6",
"LastExport": "2025-05-23T21:19:38.7927441+00:00",
"LastImport": "2025-05-23T21:19:38.7927441+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-05-23T21:19:38.7927441+00:00",
"StatusReportId": "5ecbc80d-94ff-4c4b-8db8-5988b8b8158e",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-05-23T21:19:38.7927441+00:00",
"StatusReportId": "5ecbc80d-94ff-4c4b-8db8-5988b8b8158e",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"94dd200a-1b4a-4f5c-9671-4b61134a8ee7",
"ebde9b91-fafd-4760-9b9b-e47b377eabfd"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "e22a2f2c-141c-49cd-9881-86dc8822f80f",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T21:19:38.7927441+00:00",
"End": "2025-05-23T21:19:38.7927441+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T21:19:38.7927441+00:00",
"End": "2025-05-23T21:19:38.7927441+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "fa02c372-6dca-4846-acd6-a69964346116",
"BaseRate": 2.0
},
{
"ResourceId": "fa02c372-6dca-4846-acd6-a69964346116",
"BaseRate": 2.0
}
]
},
{
"Id": "e22a2f2c-141c-49cd-9881-86dc8822f80f",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-05-23T21:19:38.7927441+00:00",
"End": "2025-05-23T21:19:38.7927441+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-05-23T21:19:38.7927441+00:00",
"End": "2025-05-23T21:19:38.7927441+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "fa02c372-6dca-4846-acd6-a69964346116",
"BaseRate": 2.0
},
{
"ResourceId": "fa02c372-6dca-4846-acd6-a69964346116",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "fdc60eb4-191a-4863-8d94-0a1575013c10",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "fdc60eb4-191a-4863-8d94-0a1575013c10",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "85c0005e-ed69-414f-9a3e-012e2475ff32",
"LockedBy": "617574ee-4999-4684-9415-a049abb90b45",
"LockedDate": "2025-05-23T21:19:38.7927441+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "a042a96b-6f9f-4dbb-be90-7cef3dbf763b",
"CurrentGateId": "ed2d7ab0-87a1-47ac-8d24-4670fb16d515",
"EnteredGate": "2025-05-23T21:19:38.7927441+00:00",
"ExitedGate": "2025-05-23T21:19:38.7927441+00:00",
"GateClosed": true,
"StepStarter": "75c6f840-1c8e-4fcf-9ef1-06065001790e",
"StepApprover": "ce7c02ff-1c83-4b34-84c0-e00eafbedfad",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "b3369c70-1218-4df5-95c1-6dd84e45b3c4",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"4bfc85fb-c744-4df8-b606-aef18f708737": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
},
"032ad303-c04e-4f60-b9e3-3fafed31c6dd": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
}
}
},
{
"StepId": "b3369c70-1218-4df5-95c1-6dd84e45b3c4",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"4bfc85fb-c744-4df8-b606-aef18f708737": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
},
"032ad303-c04e-4f60-b9e3-3fafed31c6dd": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "b3369c70-1218-4df5-95c1-6dd84e45b3c4",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"4bfc85fb-c744-4df8-b606-aef18f708737": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
},
"032ad303-c04e-4f60-b9e3-3fafed31c6dd": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
}
}
},
{
"StepId": "b3369c70-1218-4df5-95c1-6dd84e45b3c4",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"4bfc85fb-c744-4df8-b606-aef18f708737": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
},
"032ad303-c04e-4f60-b9e3-3fafed31c6dd": {
"TaskId": "9d4933b6-12ea-48d7-85e2-c47dfa8f3c9b",
"Status": 0,
"Comments": [
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
},
{
"Id": "24dc514d-c337-48c9-a105-9771045ddca1",
"UPN": "b18ae627-de4a-434f-b545-eb8ddf460d78",
"PostDate": "2025-05-23T21:19:38.7771172+00:00",
"Comment": "sample string 4",
"CC": [
"e77b8b60-4b6e-4490-8bcc-5809c6bc5630",
"2297e4d1-46d1-47f4-a7d0-d784203ecd68"
],
"Users": [
"51551f76-6e2c-4d90-9f26-6531dde7128f",
"8365d734-628e-4dd0-ade5-064bfd0d3b4c"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "2116ca57-f45c-44d6-b95a-115569abb138",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "2116ca57-f45c-44d6-b95a-115569abb138",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "3770e40a-5491-4532-ab39-a3452db54f73",
"ConfigId": "1ec6c449-3055-4950-a864-00ced8be078e"
}