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": "5d818ba6-c4e3-42f5-9df0-48e8a851ebe9",
"Created": "2026-05-02T16:48:03.9376203+00:00",
"Modified": "2026-05-02T16:48:03.9376203+00:00",
"Editor": "ea986b79-cb5f-48bd-b1db-e786fbe14ff3",
"PlannerTypeId": "aa219af1-f797-43bd-8af2-165a044917f3",
"ParentPlanId": "02a5b30f-6bb6-42b0-b379-3d1a58b1cd14",
"PortfolioParentId": "9e11b5c3-1ecf-46eb-82c1-349c99b9cdff",
"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": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
],
"LastComment": "2026-05-02T16:48:03.9376203+00:00",
"Integrations": [
{
"IntegrationId": "678ca66e-ce74-4c58-9e0d-7c7e1d3cc670",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1b524081-98a8-4bbd-a1e0-5dce0b9cbd9f",
"LastExport": "2026-05-02T16:48:03.9376203+00:00",
"LastImport": "2026-05-02T16:48:03.9376203+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "678ca66e-ce74-4c58-9e0d-7c7e1d3cc670",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1b524081-98a8-4bbd-a1e0-5dce0b9cbd9f",
"LastExport": "2026-05-02T16:48:03.9376203+00:00",
"LastImport": "2026-05-02T16:48:03.9376203+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-05-02T16:48:03.9376203+00:00",
"StatusReportId": "473a261c-41ee-4794-90b9-c6178ca3b359",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-05-02T16:48:03.9376203+00:00",
"StatusReportId": "473a261c-41ee-4794-90b9-c6178ca3b359",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"e261ca9f-88d9-4c33-accf-8cdb91f37d9e",
"d39aaebd-f5d7-4b4f-a71e-9ff8215c4c45"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "acf614bf-0308-452b-b5e9-9e2c0908358c",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-05-02T16:48:03.9376203+00:00",
"End": "2026-05-02T16:48:03.9376203+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-05-02T16:48:03.9376203+00:00",
"End": "2026-05-02T16:48:03.9376203+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "ac87f8a0-9234-4e7b-a8e2-dda8d8727e72",
"BaseRate": 2.0
},
{
"ResourceId": "ac87f8a0-9234-4e7b-a8e2-dda8d8727e72",
"BaseRate": 2.0
}
]
},
{
"Id": "acf614bf-0308-452b-b5e9-9e2c0908358c",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-05-02T16:48:03.9376203+00:00",
"End": "2026-05-02T16:48:03.9376203+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-05-02T16:48:03.9376203+00:00",
"End": "2026-05-02T16:48:03.9376203+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "ac87f8a0-9234-4e7b-a8e2-dda8d8727e72",
"BaseRate": 2.0
},
{
"ResourceId": "ac87f8a0-9234-4e7b-a8e2-dda8d8727e72",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "cdf6c8e8-d3e9-40b9-accd-ce41e7ae1a65",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "cdf6c8e8-d3e9-40b9-accd-ce41e7ae1a65",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "b7528d56-3ade-4ac4-b9b8-081f335e7ae5",
"LockedBy": "e779ac6b-44f3-423d-a889-8ed35916db82",
"LockedDate": "2026-05-02T16:48:03.9376203+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "b12e7b99-42f4-4c45-a407-db470420f220",
"CurrentGateId": "923b9d4f-f9e2-465f-8a2a-cffce6574042",
"EnteredGate": "2026-05-02T16:48:03.9376203+00:00",
"ExitedGate": "2026-05-02T16:48:03.9376203+00:00",
"GateClosed": true,
"StepStarter": "fe72fde6-7ac1-4f87-8870-ab5807bfeccd",
"StepApprover": "34325ebc-86dd-44d8-948f-f5367982cf87",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "a9f2e9e2-b7c5-4ae9-a3d8-0963a34d14bc",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"74c01c86-f72b-4bbf-b200-baa292063fd4": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
},
"cbee5c73-7626-44e0-a397-9093888e670f": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
}
}
},
{
"StepId": "a9f2e9e2-b7c5-4ae9-a3d8-0963a34d14bc",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"74c01c86-f72b-4bbf-b200-baa292063fd4": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
},
"cbee5c73-7626-44e0-a397-9093888e670f": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "a9f2e9e2-b7c5-4ae9-a3d8-0963a34d14bc",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"74c01c86-f72b-4bbf-b200-baa292063fd4": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
},
"cbee5c73-7626-44e0-a397-9093888e670f": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
}
}
},
{
"StepId": "a9f2e9e2-b7c5-4ae9-a3d8-0963a34d14bc",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"74c01c86-f72b-4bbf-b200-baa292063fd4": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
},
"cbee5c73-7626-44e0-a397-9093888e670f": {
"TaskId": "06521778-1097-43cb-a63d-bab0c8f56c89",
"Status": 0,
"Comments": [
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
},
{
"Id": "d24c7597-3fd5-41c3-954f-f6287eba7d99",
"UPN": "0391f163-a1f5-4339-8de9-f01d5c5cc9a2",
"PostDate": "2026-05-02T16:48:03.9376203+00:00",
"Comment": "sample string 4",
"CC": [
"a92f2480-7931-4bdc-b44a-06c5dfddac1b",
"e990c90c-50bb-49e7-b0d3-0a1e49535897"
],
"Users": [
"644e9389-9b12-4207-a5d7-685702cc5205",
"a70daa36-a054-4044-811a-4e8e38152163"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "3ca9370e-e66d-4ced-a332-c3ad6ff26f5f",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "3ca9370e-e66d-4ced-a332-c3ad6ff26f5f",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "6b65b44a-5e1b-4fce-aa52-9a1845222022",
"ConfigId": "827dc0c4-09d6-4623-9dcb-6febabf451bf"
}