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": "12c0bedb-aa82-4fe2-9ef2-3299e80f4c61",
"Created": "2026-07-01T16:21:00.4757605+00:00",
"Modified": "2026-07-01T16:21:00.4757605+00:00",
"Editor": "752c097c-896b-4b68-83f9-9383d485f4ca",
"PlannerTypeId": "2e062f8e-8604-4d4d-a864-1ef9bc264791",
"ParentPlanId": "96f587e5-5c28-4d0f-8558-cde6fae0ab2a",
"PortfolioParentId": "116facc6-6bc7-4cd5-8729-bf6290fe0246",
"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": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
],
"LastComment": "2026-07-01T16:21:00.4757605+00:00",
"Integrations": [
{
"IntegrationId": "754c6968-1ab1-4ad8-9628-0e9677aec451",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "a0646ea7-2677-441a-995a-55195a23a0e6",
"LastExport": "2026-07-01T16:21:00.4757605+00:00",
"LastImport": "2026-07-01T16:21:00.4757605+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "754c6968-1ab1-4ad8-9628-0e9677aec451",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "a0646ea7-2677-441a-995a-55195a23a0e6",
"LastExport": "2026-07-01T16:21:00.4757605+00:00",
"LastImport": "2026-07-01T16:21:00.4757605+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-01T16:21:00.4757605+00:00",
"StatusReportId": "014cd3a9-9496-4841-9d7e-75c189d4dd9b",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-01T16:21:00.4757605+00:00",
"StatusReportId": "014cd3a9-9496-4841-9d7e-75c189d4dd9b",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"a0d2b7e5-bd99-47fe-a002-cf8cac822c2f",
"e9e71b21-afd4-4f8e-8841-037788d3f80f"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "2df4689a-5576-40e7-9587-58a8dab54d01",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:21:00.4757605+00:00",
"End": "2026-07-01T16:21:00.4757605+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:21:00.4757605+00:00",
"End": "2026-07-01T16:21:00.4757605+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "5d7a6456-8164-4efc-b37e-236e8390016e",
"BaseRate": 2.0
},
{
"ResourceId": "5d7a6456-8164-4efc-b37e-236e8390016e",
"BaseRate": 2.0
}
]
},
{
"Id": "2df4689a-5576-40e7-9587-58a8dab54d01",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-01T16:21:00.4757605+00:00",
"End": "2026-07-01T16:21:00.4757605+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-01T16:21:00.4757605+00:00",
"End": "2026-07-01T16:21:00.4757605+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "5d7a6456-8164-4efc-b37e-236e8390016e",
"BaseRate": 2.0
},
{
"ResourceId": "5d7a6456-8164-4efc-b37e-236e8390016e",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "7720788f-183d-4ecc-9a12-1da1f9e83d33",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "7720788f-183d-4ecc-9a12-1da1f9e83d33",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "aa28e5ec-574d-4ab9-bd26-abcdbeadfeca",
"LockedBy": "5a1f18d3-5130-4862-acb7-bbeab1f1e984",
"LockedDate": "2026-07-01T16:21:00.4757605+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "d6fc4fc8-9757-467e-b64e-76b5f5b38f51",
"CurrentGateId": "91808a18-953f-47ba-b6c0-a74bf17b3c70",
"EnteredGate": "2026-07-01T16:21:00.4757605+00:00",
"ExitedGate": "2026-07-01T16:21:00.4757605+00:00",
"GateClosed": true,
"StepStarter": "2bd8558c-3f26-4d86-a73d-baa4929fadd3",
"StepApprover": "88ee6a59-7f5c-420e-8603-f53c64d055d7",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "73a0db7d-5aa8-4438-bf8a-b7954c3882b0",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"ac9669c0-a6c6-4871-b2f4-5731f39fe30c": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
},
"c95a6a3e-7f6b-4ede-bf20-170525290874": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
}
}
},
{
"StepId": "73a0db7d-5aa8-4438-bf8a-b7954c3882b0",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"ac9669c0-a6c6-4871-b2f4-5731f39fe30c": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
},
"c95a6a3e-7f6b-4ede-bf20-170525290874": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "73a0db7d-5aa8-4438-bf8a-b7954c3882b0",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"ac9669c0-a6c6-4871-b2f4-5731f39fe30c": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
},
"c95a6a3e-7f6b-4ede-bf20-170525290874": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
}
}
},
{
"StepId": "73a0db7d-5aa8-4438-bf8a-b7954c3882b0",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"ac9669c0-a6c6-4871-b2f4-5731f39fe30c": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
},
"c95a6a3e-7f6b-4ede-bf20-170525290874": {
"TaskId": "6d92de13-0abe-43b8-b311-803b64ea06d7",
"Status": 0,
"Comments": [
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
},
{
"Id": "ec458a17-43cb-40d1-98e4-1afd601c4844",
"UPN": "1f0c423c-b78a-4fc7-874b-facdb4ca6b9e",
"PostDate": "2026-07-01T16:21:00.4757605+00:00",
"Comment": "sample string 4",
"CC": [
"0049544b-d730-470b-8962-d91a19805a1c",
"8f9607bd-14b1-4446-a360-391416d7e496"
],
"Users": [
"29629380-b38b-428e-8d71-6a4c66f07036",
"f9e5ad5a-81ce-4575-b55e-b39b37a994e7"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "1994a522-340f-480a-baf4-79401fb1673e",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "1994a522-340f-480a-baf4-79401fb1673e",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "22bd85fb-3ee8-4769-b8f3-fee28c239429",
"ConfigId": "b5558d1c-4e55-4e3f-9163-bf7f8beac603"
}