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": "c6ce79d0-bd46-458e-b278-5527a8e84133",
"Created": "2025-07-08T19:18:48.4250707+00:00",
"Modified": "2025-07-08T19:18:48.4250707+00:00",
"Editor": "c9cf810f-a353-4954-a03d-d378d4f94824",
"PlannerTypeId": "276fee29-3be9-446c-a621-4f0b21f20b86",
"ParentPlanId": "69bdb6b0-dff6-4c2e-a84f-8584606b97dc",
"PortfolioParentId": "1f0ae454-d7f9-4bb7-8fa3-3d1cf3368c02",
"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": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
],
"LastComment": "2025-07-08T19:18:48.4250707+00:00",
"Integrations": [
{
"IntegrationId": "d2b4804b-a6b8-489f-9409-01954b212b20",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "c8a063fa-d14f-4ff0-98f9-6e82be7e7ad1",
"LastExport": "2025-07-08T19:18:48.4250707+00:00",
"LastImport": "2025-07-08T19:18:48.4250707+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "d2b4804b-a6b8-489f-9409-01954b212b20",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "c8a063fa-d14f-4ff0-98f9-6e82be7e7ad1",
"LastExport": "2025-07-08T19:18:48.4250707+00:00",
"LastImport": "2025-07-08T19:18:48.4250707+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-08T19:18:48.4250707+00:00",
"StatusReportId": "09181965-5973-435e-8c1b-979ae2e7131c",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-08T19:18:48.4250707+00:00",
"StatusReportId": "09181965-5973-435e-8c1b-979ae2e7131c",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"a5b2420c-c8d8-41db-998c-b91e680b4f91",
"2434af65-e04e-4a90-9260-b67032287877"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "93532951-c4a1-405d-a787-61ee18ac8329",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T19:18:48.4250707+00:00",
"End": "2025-07-08T19:18:48.4250707+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T19:18:48.4250707+00:00",
"End": "2025-07-08T19:18:48.4250707+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "7f19a464-2c51-4f77-8b7e-e9bb407311ea",
"BaseRate": 2.0
},
{
"ResourceId": "7f19a464-2c51-4f77-8b7e-e9bb407311ea",
"BaseRate": 2.0
}
]
},
{
"Id": "93532951-c4a1-405d-a787-61ee18ac8329",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T19:18:48.4250707+00:00",
"End": "2025-07-08T19:18:48.4250707+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T19:18:48.4250707+00:00",
"End": "2025-07-08T19:18:48.4250707+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "7f19a464-2c51-4f77-8b7e-e9bb407311ea",
"BaseRate": 2.0
},
{
"ResourceId": "7f19a464-2c51-4f77-8b7e-e9bb407311ea",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "3ab0b9c6-3aed-4f94-b0ad-a72190fddea1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "3ab0b9c6-3aed-4f94-b0ad-a72190fddea1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "0022e535-96fd-459d-a734-37c266c88b83",
"LockedBy": "805ef0d0-28d3-4ee3-92f0-d72182975762",
"LockedDate": "2025-07-08T19:18:48.4250707+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "a23f883b-fa1f-4e5f-beb8-5062e50974ea",
"CurrentGateId": "9acea969-0438-4355-bb2a-ba41c6aa7b27",
"EnteredGate": "2025-07-08T19:18:48.4250707+00:00",
"ExitedGate": "2025-07-08T19:18:48.4250707+00:00",
"GateClosed": true,
"StepStarter": "1d4f0ed3-dba3-4b6b-b72e-67257d9cb2b1",
"StepApprover": "12d67289-a28c-4422-bd51-f78b06f6318d",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "cb231046-435e-439e-9cab-38d5065d1055",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"faad16c0-2e45-48b1-9799-b8dd6a23e84d": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
},
"3f057794-feea-4cea-b913-5561606264ed": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
}
}
},
{
"StepId": "cb231046-435e-439e-9cab-38d5065d1055",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"faad16c0-2e45-48b1-9799-b8dd6a23e84d": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
},
"3f057794-feea-4cea-b913-5561606264ed": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "cb231046-435e-439e-9cab-38d5065d1055",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"faad16c0-2e45-48b1-9799-b8dd6a23e84d": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
},
"3f057794-feea-4cea-b913-5561606264ed": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
}
}
},
{
"StepId": "cb231046-435e-439e-9cab-38d5065d1055",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"faad16c0-2e45-48b1-9799-b8dd6a23e84d": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
},
"3f057794-feea-4cea-b913-5561606264ed": {
"TaskId": "2cbee1e3-044e-4652-87bd-4be7799462d6",
"Status": 0,
"Comments": [
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
},
{
"Id": "b042dc85-a3d9-4aeb-ba87-7bc74d6ded46",
"UPN": "39d0d3ac-7f37-40df-918b-41c9ddeca46e",
"PostDate": "2025-07-08T19:18:48.4250707+00:00",
"Comment": "sample string 4",
"CC": [
"bd50b371-7a5e-4039-9b83-469ecb87325c",
"a4212e66-83b5-4b4f-ad45-385a8fba36db"
],
"Users": [
"a9f886da-9424-48f3-bc6d-38bbc40f85d7",
"acbca52e-66ad-4931-a237-8ec7ded2ec0c"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "a8d2a8f5-f285-418b-890e-ece48b54c24e",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "a8d2a8f5-f285-418b-890e-ece48b54c24e",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "a5ac6fd3-a3f7-4742-b996-d4d550a08ad5",
"ConfigId": "302c3bf1-1be3-4e8d-9b5e-f1b83e830cdb"
}