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. |
|
| IsPrivate | boolean |
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": "88f26cc9-9fb3-4de4-ac38-41061b53be4b",
"Created": "2026-09-29T19:21:42.8265876+00:00",
"Modified": "2026-09-29T19:21:42.8265876+00:00",
"Editor": "ff6c7e20-7118-461b-aa47-b1a68617f5dc",
"PlannerTypeId": "7b77b0c6-96be-49c3-8998-3df8007e0d3b",
"ParentPlanId": "42424ce8-b7e0-4c01-a19e-ff073614d7e2",
"PortfolioParentId": "c41c0609-9961-4a56-bb4b-e901a0874a1b",
"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": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
],
"LastComment": "2026-09-29T19:21:42.8265876+00:00",
"Integrations": [
{
"IntegrationId": "0d5c3308-73d1-4c03-8dd9-86cc627fba9d",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "0e2b1929-a3d8-4acb-b10f-ac625a87136f",
"LastExport": "2026-09-29T19:21:42.8265876+00:00",
"LastImport": "2026-09-29T19:21:42.8265876+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "0d5c3308-73d1-4c03-8dd9-86cc627fba9d",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "0e2b1929-a3d8-4acb-b10f-ac625a87136f",
"LastExport": "2026-09-29T19:21:42.8265876+00:00",
"LastImport": "2026-09-29T19:21:42.8265876+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-09-29T19:21:42.8265876+00:00",
"StatusReportId": "03c80658-19ef-4013-84d4-c63ddc82bedb",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-09-29T19:21:42.8265876+00:00",
"StatusReportId": "03c80658-19ef-4013-84d4-c63ddc82bedb",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"da457c6b-54f2-4fc5-b38b-ccdba61edcf9",
"f0766863-1442-4a80-b719-10caf961affa"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "8ec8fa75-c8f4-4b0b-bf55-74a19c435a25",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:21:42.8265876+00:00",
"End": "2026-09-29T19:21:42.8265876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:21:42.8265876+00:00",
"End": "2026-09-29T19:21:42.8265876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "29e63450-8a41-44ac-8931-06533f1e43ff",
"BaseRate": 2.0
},
{
"ResourceId": "29e63450-8a41-44ac-8931-06533f1e43ff",
"BaseRate": 2.0
}
]
},
{
"Id": "8ec8fa75-c8f4-4b0b-bf55-74a19c435a25",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-09-29T19:21:42.8265876+00:00",
"End": "2026-09-29T19:21:42.8265876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-09-29T19:21:42.8265876+00:00",
"End": "2026-09-29T19:21:42.8265876+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "29e63450-8a41-44ac-8931-06533f1e43ff",
"BaseRate": 2.0
},
{
"ResourceId": "29e63450-8a41-44ac-8931-06533f1e43ff",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "5e7d0a06-e02c-4df4-a78b-cdeeb0a2b0b4",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "5e7d0a06-e02c-4df4-a78b-cdeeb0a2b0b4",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "55ab2c7e-7281-43c5-826b-8d97d786d338",
"LockedBy": "1490b880-c835-4b87-8eb7-a1f1051cc61a",
"LockedDate": "2026-09-29T19:21:42.8265876+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "bd5f245f-987b-4c80-93f5-74a3bf9b4cf9",
"CurrentGateId": "4f886b5f-07e0-45d8-9a7d-2945c973bb55",
"EnteredGate": "2026-09-29T19:21:42.8265876+00:00",
"ExitedGate": "2026-09-29T19:21:42.8265876+00:00",
"GateClosed": true,
"StepStarter": "5a0ff2a5-be1a-41b7-869e-fdd6ebf32944",
"StepApprover": "d148d3ac-f086-44bd-af7c-2998c3b144e9",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "e6a4ab5d-8b4c-48d4-835f-8bdccdcce2cf",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7ee44db2-dda0-4ff6-9e18-7fa102198ef1": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
},
"accf11e3-37fc-446e-a2fe-64c129294796": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
}
}
},
{
"StepId": "e6a4ab5d-8b4c-48d4-835f-8bdccdcce2cf",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7ee44db2-dda0-4ff6-9e18-7fa102198ef1": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
},
"accf11e3-37fc-446e-a2fe-64c129294796": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "e6a4ab5d-8b4c-48d4-835f-8bdccdcce2cf",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7ee44db2-dda0-4ff6-9e18-7fa102198ef1": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
},
"accf11e3-37fc-446e-a2fe-64c129294796": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
}
}
},
{
"StepId": "e6a4ab5d-8b4c-48d4-835f-8bdccdcce2cf",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"7ee44db2-dda0-4ff6-9e18-7fa102198ef1": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
},
"accf11e3-37fc-446e-a2fe-64c129294796": {
"TaskId": "a691e0e9-6292-4c4c-9f09-70c6c36ca0ad",
"Status": 0,
"Comments": [
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
},
{
"Id": "2e129cdb-cae8-4836-adc7-003b970b9765",
"UPN": "9cf1c9ed-8c8d-4094-bc51-b61778f32bdc",
"PostDate": "2026-09-29T19:21:42.8265876+00:00",
"Comment": "sample string 4",
"CC": [
"883078d3-7270-44e1-a340-df37df8f9aa3",
"9f05210b-9d98-4f8b-97a5-a7847cbee9b2"
],
"Users": [
"e2b07bbd-ed3b-458d-92a1-d31a9b2cdce8",
"4f1398f4-45ca-4293-91b6-99f79776811b"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "66f3c950-27ee-4a54-909b-67d6b071afcf",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "66f3c950-27ee-4a54-909b-67d6b071afcf",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"IsPrivate": true,
"id": "ab6ba5c5-92fd-4ff0-a07b-1c4423539d3e",
"ConfigId": "50974065-782d-4d4f-a672-c4afe6223492"
}