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": "ee65b590-419e-4e97-a0ca-7aa8e57a1b48",
"Created": "2025-04-04T02:38:32.9029353+00:00",
"Modified": "2025-04-04T02:38:32.9029353+00:00",
"Editor": "e7c2f1df-f198-46af-807b-f2e6441869b8",
"PlannerTypeId": "d632456b-1888-40ca-b4d8-53752709b677",
"ParentPlanId": "85abafb3-cf06-4ed7-acd1-23dbc3aa22fb",
"PortfolioParentId": "e802600a-604d-4f75-9141-36ac2ad37bf8",
"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": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
],
"LastComment": "2025-04-04T02:38:32.9029353+00:00",
"Integrations": [
{
"IntegrationId": "2b984c2e-7bff-477c-a3b9-fb2fa940c5a1",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e37bb424-9ffe-4c5b-af91-11a64b36234c",
"LastExport": "2025-04-04T02:38:32.9029353+00:00",
"LastImport": "2025-04-04T02:38:32.9029353+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "2b984c2e-7bff-477c-a3b9-fb2fa940c5a1",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e37bb424-9ffe-4c5b-af91-11a64b36234c",
"LastExport": "2025-04-04T02:38:32.9029353+00:00",
"LastImport": "2025-04-04T02:38:32.9029353+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-04-04T02:38:32.9029353+00:00",
"StatusReportId": "98c2739c-6c40-4ce4-bc49-e672c338afd4",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-04-04T02:38:32.9029353+00:00",
"StatusReportId": "98c2739c-6c40-4ce4-bc49-e672c338afd4",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"be99749b-9f4c-4208-9cb4-50150425108b",
"bd97f3ee-c1e8-452d-8980-2ca279a6ce57"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "a3ee2fea-ad6d-44dc-a478-708a68cb6670",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:38:32.9029353+00:00",
"End": "2025-04-04T02:38:32.9029353+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:38:32.9029353+00:00",
"End": "2025-04-04T02:38:32.9029353+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "8ffdfb5e-bc3a-4fff-aca2-f6a550fdc541",
"BaseRate": 2.0
},
{
"ResourceId": "8ffdfb5e-bc3a-4fff-aca2-f6a550fdc541",
"BaseRate": 2.0
}
]
},
{
"Id": "a3ee2fea-ad6d-44dc-a478-708a68cb6670",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:38:32.9029353+00:00",
"End": "2025-04-04T02:38:32.9029353+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:38:32.9029353+00:00",
"End": "2025-04-04T02:38:32.9029353+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "8ffdfb5e-bc3a-4fff-aca2-f6a550fdc541",
"BaseRate": 2.0
},
{
"ResourceId": "8ffdfb5e-bc3a-4fff-aca2-f6a550fdc541",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "fbae6dac-1cc9-40e5-be5c-706322872b7c",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "fbae6dac-1cc9-40e5-be5c-706322872b7c",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "c6227216-c764-4f56-ae44-a2f4229336a4",
"LockedBy": "3534f8be-2df4-4e3f-a28f-4c32a40e6482",
"LockedDate": "2025-04-04T02:38:32.9029353+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "78116f4a-69c3-4950-8a0b-1c450ef5b005",
"CurrentGateId": "7333326e-f669-4919-8acd-095483bb2d06",
"EnteredGate": "2025-04-04T02:38:32.9029353+00:00",
"ExitedGate": "2025-04-04T02:38:32.9029353+00:00",
"GateClosed": true,
"StepStarter": "8c382be7-a25f-4585-9512-c5ce29b92086",
"StepApprover": "89e10d31-9ff4-4ce2-87fc-18826af4941a",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "fe4d1ccb-16eb-4225-9388-e13ca710d8ff",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"dacb91ae-e8e4-4ee4-89e2-b2a71519a81b": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
},
"05eb00d5-8359-45c1-acea-b0e53f766e91": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
}
}
},
{
"StepId": "fe4d1ccb-16eb-4225-9388-e13ca710d8ff",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"dacb91ae-e8e4-4ee4-89e2-b2a71519a81b": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
},
"05eb00d5-8359-45c1-acea-b0e53f766e91": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "fe4d1ccb-16eb-4225-9388-e13ca710d8ff",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"dacb91ae-e8e4-4ee4-89e2-b2a71519a81b": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
},
"05eb00d5-8359-45c1-acea-b0e53f766e91": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
}
}
},
{
"StepId": "fe4d1ccb-16eb-4225-9388-e13ca710d8ff",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"dacb91ae-e8e4-4ee4-89e2-b2a71519a81b": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
},
"05eb00d5-8359-45c1-acea-b0e53f766e91": {
"TaskId": "dbc659ae-6e88-4407-92dc-174a5ee5a626",
"Status": 0,
"Comments": [
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
},
{
"Id": "46683aac-ec2d-494f-9092-5b18b426c9dc",
"UPN": "8a1ec445-0ce2-449e-82c0-196bb7abbdd1",
"PostDate": "2025-04-04T02:38:32.9029353+00:00",
"Comment": "sample string 4",
"CC": [
"8c2feab2-309a-4920-8497-1d586a938398",
"97f5b56b-a73f-4b16-a09f-a852ad509d6a"
],
"Users": [
"18c1dc5a-9961-4c39-adb2-a39a97b97c00",
"92a60fff-4a08-4582-8708-07ad662f458b"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "ccef7f3f-3608-4015-ad6f-00641ee53d7a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "ccef7f3f-3608-4015-ad6f-00641ee53d7a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "94838095-33c0-4cf0-a753-cb7dfcfec81b",
"ConfigId": "8e4bfe78-115f-4f77-8c62-d914a7108131"
}