POST api/workplan/{id}/updatefragment
Save workplan as fragment
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
FragmentInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Description | string |
None. |
|
| Category | string |
None. |
|
| WorkTypes | string |
None. |
|
| Personal | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Description": "sample string 2",
"Category": "sample string 3",
"WorkTypes": "sample string 4",
"Personal": true
}
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": "e71028af-67b9-41d7-965b-ed32dffff929",
"Created": "2026-06-05T16:23:41.5971947+00:00",
"Modified": "2026-06-05T16:23:41.5971947+00:00",
"Editor": "8527468d-cf5d-48e8-aa57-5473a5555983",
"PlannerTypeId": "eebaa53f-90ee-4c82-bcf1-5874e65e6b76",
"ParentPlanId": "d99a1d25-cbc3-4c65-a233-ee9b588427d8",
"PortfolioParentId": "824b5cb2-ac9f-4a55-81fa-d784e2ff36f2",
"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": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
],
"LastComment": "2026-06-05T16:23:41.5971947+00:00",
"Integrations": [
{
"IntegrationId": "457dbb93-f6d3-4337-b69a-4e4d71314d01",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "53b1bdb2-3df9-4fc8-b688-b693084c696d",
"LastExport": "2026-06-05T16:23:41.5971947+00:00",
"LastImport": "2026-06-05T16:23:41.5971947+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "457dbb93-f6d3-4337-b69a-4e4d71314d01",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "53b1bdb2-3df9-4fc8-b688-b693084c696d",
"LastExport": "2026-06-05T16:23:41.5971947+00:00",
"LastImport": "2026-06-05T16:23:41.5971947+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-06-05T16:23:41.5971947+00:00",
"StatusReportId": "c39de762-5426-4580-a9d8-5c1bb1f76c93",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-06-05T16:23:41.5971947+00:00",
"StatusReportId": "c39de762-5426-4580-a9d8-5c1bb1f76c93",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"f55a8082-ecfb-47be-8246-9ee5f9ffbb50",
"49a15c04-9826-4a39-b6d6-5a5df15764b8"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "b72c830d-e93d-47a1-b9d4-3796a9fa29f3",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-06-05T16:23:41.5971947+00:00",
"End": "2026-06-05T16:23:41.5971947+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-06-05T16:23:41.5971947+00:00",
"End": "2026-06-05T16:23:41.5971947+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9153bf5a-f603-4df1-afa9-91d9dd4590de",
"BaseRate": 2.0
},
{
"ResourceId": "9153bf5a-f603-4df1-afa9-91d9dd4590de",
"BaseRate": 2.0
}
]
},
{
"Id": "b72c830d-e93d-47a1-b9d4-3796a9fa29f3",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-06-05T16:23:41.5971947+00:00",
"End": "2026-06-05T16:23:41.5971947+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-06-05T16:23:41.5971947+00:00",
"End": "2026-06-05T16:23:41.5971947+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "9153bf5a-f603-4df1-afa9-91d9dd4590de",
"BaseRate": 2.0
},
{
"ResourceId": "9153bf5a-f603-4df1-afa9-91d9dd4590de",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "6cdbe963-bba3-4f45-92ef-726a333cacb9",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "6cdbe963-bba3-4f45-92ef-726a333cacb9",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "980ee111-67b8-4213-b9bb-bb771e61788e",
"LockedBy": "663c39f1-41a4-4351-b946-e57041bc927f",
"LockedDate": "2026-06-05T16:23:41.5971947+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "9055abae-21a8-4dca-9457-7f09b3335d5a",
"CurrentGateId": "098b9ea5-2fd3-4425-9448-929735985b7e",
"EnteredGate": "2026-06-05T16:23:41.5971947+00:00",
"ExitedGate": "2026-06-05T16:23:41.5971947+00:00",
"GateClosed": true,
"StepStarter": "65928abb-bf76-493d-a782-134da5e1c2b3",
"StepApprover": "703c27f9-a0b4-475b-8584-432218091cec",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "990a16e1-1be9-4eff-afe9-5f56bdd90d3d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c8979d90-5df0-4549-a42d-298a39b6d5f3": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
},
"8aee7980-beff-42ca-8412-386632f46abb": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
}
}
},
{
"StepId": "990a16e1-1be9-4eff-afe9-5f56bdd90d3d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c8979d90-5df0-4549-a42d-298a39b6d5f3": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
},
"8aee7980-beff-42ca-8412-386632f46abb": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "990a16e1-1be9-4eff-afe9-5f56bdd90d3d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c8979d90-5df0-4549-a42d-298a39b6d5f3": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
},
"8aee7980-beff-42ca-8412-386632f46abb": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
}
}
},
{
"StepId": "990a16e1-1be9-4eff-afe9-5f56bdd90d3d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"c8979d90-5df0-4549-a42d-298a39b6d5f3": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
},
"8aee7980-beff-42ca-8412-386632f46abb": {
"TaskId": "f36faa21-f8be-4c5e-b7d3-b6e23c152180",
"Status": 0,
"Comments": [
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
},
{
"Id": "5aea5519-5a77-4a9e-84bf-0a59547d21cd",
"UPN": "116f8e41-e6c9-4602-9e66-93079d71c45c",
"PostDate": "2026-06-05T16:23:41.5971947+00:00",
"Comment": "sample string 4",
"CC": [
"5bc1d791-1f9a-4b14-b48a-a93ff0306d87",
"e2926b3b-a4b5-4b1b-9d29-370b7f38aad1"
],
"Users": [
"a343df4f-5b42-4215-842e-0e874b043840",
"a1fe108c-0ee4-46b2-97ef-9d79a0993915"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "b0e10e67-30ec-419f-be71-f18a8e4139a9",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "b0e10e67-30ec-419f-be71-f18a8e4139a9",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "8dc8b9f8-c911-437c-b0de-76f27d45fe6c",
"ConfigId": "7c377b59-7876-4b3f-997b-7a92de4d12f7"
}