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": "801d809a-cfe1-4023-bb13-d31b241fb41b",
"Created": "2024-12-11T20:36:58.2605352+00:00",
"Modified": "2024-12-11T20:36:58.2605352+00:00",
"Editor": "9495fde1-15fe-49f6-a500-119a135d05ad",
"PlannerTypeId": "115afa3c-551e-41c1-ba99-b5b49528ab04",
"ParentPlanId": "68bbc2a7-0aed-4c04-863f-27625b657e4b",
"PortfolioParentId": "eac4af96-9a96-4fb0-9808-c9b1213acafb",
"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": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
],
"LastComment": "2024-12-11T20:36:58.2605352+00:00",
"Integrations": [
{
"IntegrationId": "a39930fb-58e1-4446-8cc2-7d184917cc38",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "d023d68e-676c-40ae-a498-eb7ddcd70252",
"LastExport": "2024-12-11T20:36:58.2605352+00:00",
"LastImport": "2024-12-11T20:36:58.2605352+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "a39930fb-58e1-4446-8cc2-7d184917cc38",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "d023d68e-676c-40ae-a498-eb7ddcd70252",
"LastExport": "2024-12-11T20:36:58.2605352+00:00",
"LastImport": "2024-12-11T20:36:58.2605352+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2024-12-11T20:36:58.2605352+00:00",
"StatusReportId": "ea87d81d-b2b4-447b-957c-7007041fa7f3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2024-12-11T20:36:58.2605352+00:00",
"StatusReportId": "ea87d81d-b2b4-447b-957c-7007041fa7f3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"aebd8cc5-ca91-4e58-9ddc-c7f07ceb841f",
"85139146-f0b7-4195-9cd9-f54d0a8943db"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "ea064f8b-6d22-4736-808e-9b9b6d8867c9",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2024-12-11T20:36:58.2605352+00:00",
"End": "2024-12-11T20:36:58.2605352+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2024-12-11T20:36:58.2605352+00:00",
"End": "2024-12-11T20:36:58.2605352+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "61a74d20-4c2b-4ef9-a85d-60d1f7376722",
"BaseRate": 2.0
},
{
"ResourceId": "61a74d20-4c2b-4ef9-a85d-60d1f7376722",
"BaseRate": 2.0
}
]
},
{
"Id": "ea064f8b-6d22-4736-808e-9b9b6d8867c9",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2024-12-11T20:36:58.2605352+00:00",
"End": "2024-12-11T20:36:58.2605352+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2024-12-11T20:36:58.2605352+00:00",
"End": "2024-12-11T20:36:58.2605352+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "61a74d20-4c2b-4ef9-a85d-60d1f7376722",
"BaseRate": 2.0
},
{
"ResourceId": "61a74d20-4c2b-4ef9-a85d-60d1f7376722",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "7a9b20c1-af7e-4166-a67e-0547533e2ad0",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "7a9b20c1-af7e-4166-a67e-0547533e2ad0",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "1f74ae44-0bc9-4a21-a49b-9049ffe26dda",
"LockedBy": "8f61fe09-a0aa-4db1-8b17-c77747602896",
"LockedDate": "2024-12-11T20:36:58.2605352+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "7b7ab388-7056-446e-ae57-d1ada0465853",
"CurrentGateId": "fd679859-032d-4e2d-b348-51c060184bb1",
"EnteredGate": "2024-12-11T20:36:58.2605352+00:00",
"ExitedGate": "2024-12-11T20:36:58.2605352+00:00",
"GateClosed": true,
"StepStarter": "4d641ff9-e4ad-4f1f-b013-44bab3134d44",
"StepApprover": "b58ff512-9f6f-47a2-afb6-e9ca764cebc8",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "4a78d62d-0171-4ba1-a070-5afe614efdf1",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2335edf5-04a2-4fb0-bcfb-42047ab9ecc9": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
},
"8b5c2be9-b93d-4fe0-b933-94db7ead2fd5": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
}
}
},
{
"StepId": "4a78d62d-0171-4ba1-a070-5afe614efdf1",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2335edf5-04a2-4fb0-bcfb-42047ab9ecc9": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
},
"8b5c2be9-b93d-4fe0-b933-94db7ead2fd5": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "4a78d62d-0171-4ba1-a070-5afe614efdf1",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2335edf5-04a2-4fb0-bcfb-42047ab9ecc9": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
},
"8b5c2be9-b93d-4fe0-b933-94db7ead2fd5": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
}
}
},
{
"StepId": "4a78d62d-0171-4ba1-a070-5afe614efdf1",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2335edf5-04a2-4fb0-bcfb-42047ab9ecc9": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
},
"8b5c2be9-b93d-4fe0-b933-94db7ead2fd5": {
"TaskId": "add305f3-9e2a-4f90-89b2-c80be67d9948",
"Status": 0,
"Comments": [
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
},
{
"Id": "767eaa5c-cb47-42cc-bcce-7f52ad04f3de",
"UPN": "b4f427e2-536f-430b-bf10-60c38bdf1d6e",
"PostDate": "2024-12-11T20:36:58.2605352+00:00",
"Comment": "sample string 4",
"CC": [
"5f95b97d-99a1-4eec-a808-ffe002b600d8",
"194b3cb8-1511-4e49-8c17-e4dc11d1a1e1"
],
"Users": [
"1cbe86e7-7ca6-42b5-8df0-0e07b83a3368",
"ee99fb72-b093-42b4-8100-1c72cf6b0924"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "e13db1c2-b3ea-4bc7-8071-d555f4d31d8a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "e13db1c2-b3ea-4bc7-8071-d555f4d31d8a",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "0632a49c-c881-4429-a9e6-1bf9984f484d",
"ConfigId": "556876d9-740d-4733-8abd-b191c785c54d"
}