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": "63348cd1-c0dd-4976-94cf-414234403a61",
"Created": "2026-07-21T13:09:15.4306856+00:00",
"Modified": "2026-07-21T13:09:15.4306856+00:00",
"Editor": "71f1a290-91f5-4a46-b46e-afeb96a97f38",
"PlannerTypeId": "d538d43a-2b9a-4fb3-8fd3-8dbe30394426",
"ParentPlanId": "fa0f2452-edd2-4dcc-b340-d84db757d4f0",
"PortfolioParentId": "d26b7b12-e72f-49b7-976c-462a95e0da19",
"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": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
],
"LastComment": "2026-07-21T13:09:15.4306856+00:00",
"Integrations": [
{
"IntegrationId": "a631b20c-5e8c-4020-b014-85e9173d803c",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "98c70be2-632c-47cd-a216-290340fa1059",
"LastExport": "2026-07-21T13:09:15.4306856+00:00",
"LastImport": "2026-07-21T13:09:15.4306856+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "a631b20c-5e8c-4020-b014-85e9173d803c",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "98c70be2-632c-47cd-a216-290340fa1059",
"LastExport": "2026-07-21T13:09:15.4306856+00:00",
"LastImport": "2026-07-21T13:09:15.4306856+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2026-07-21T13:09:15.4306856+00:00",
"StatusReportId": "a98a8ea5-8348-4846-be26-7ef7cc61e2b8",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2026-07-21T13:09:15.4306856+00:00",
"StatusReportId": "a98a8ea5-8348-4846-be26-7ef7cc61e2b8",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"128da4f3-a139-489e-b9f3-4635e9db9dea",
"fc869a28-e175-489c-b0d0-414a4014687f"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "f63f2ac3-da30-41b3-9918-4ce5d2aa482f",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:09:15.4306856+00:00",
"End": "2026-07-21T13:09:15.4306856+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:09:15.4306856+00:00",
"End": "2026-07-21T13:09:15.4306856+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "1d57e2a5-eaaf-4e2b-9bff-c98589f01e87",
"BaseRate": 2.0
},
{
"ResourceId": "1d57e2a5-eaaf-4e2b-9bff-c98589f01e87",
"BaseRate": 2.0
}
]
},
{
"Id": "f63f2ac3-da30-41b3-9918-4ce5d2aa482f",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2026-07-21T13:09:15.4306856+00:00",
"End": "2026-07-21T13:09:15.4306856+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2026-07-21T13:09:15.4306856+00:00",
"End": "2026-07-21T13:09:15.4306856+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "1d57e2a5-eaaf-4e2b-9bff-c98589f01e87",
"BaseRate": 2.0
},
{
"ResourceId": "1d57e2a5-eaaf-4e2b-9bff-c98589f01e87",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "e50bee1b-f0ed-48ae-91f5-fc3c91c2b2d2",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "e50bee1b-f0ed-48ae-91f5-fc3c91c2b2d2",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "21c15197-4124-4fdf-b73a-169711e057da",
"LockedBy": "9c968128-363d-4998-a8f5-0bc94bd9cbfc",
"LockedDate": "2026-07-21T13:09:15.4306856+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "85abe74c-de07-4bc4-b34b-de3f0873b5b7",
"CurrentGateId": "24750c2d-6191-40d0-a8ee-9e150475a226",
"EnteredGate": "2026-07-21T13:09:15.4306856+00:00",
"ExitedGate": "2026-07-21T13:09:15.4306856+00:00",
"GateClosed": true,
"StepStarter": "41ec79fd-ac01-45b8-af88-aff84bfcb85c",
"StepApprover": "642b83d4-8e93-43bf-9490-a869b1b3f7d3",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "b48d3e4d-f0d1-40f4-b433-ec2029750e2b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"91399eea-b2c1-43b9-a2a3-dde87573d5a8": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
},
"ab5b6d4a-a68f-4655-91c5-7461627848a1": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
}
}
},
{
"StepId": "b48d3e4d-f0d1-40f4-b433-ec2029750e2b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"91399eea-b2c1-43b9-a2a3-dde87573d5a8": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
},
"ab5b6d4a-a68f-4655-91c5-7461627848a1": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "b48d3e4d-f0d1-40f4-b433-ec2029750e2b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"91399eea-b2c1-43b9-a2a3-dde87573d5a8": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
},
"ab5b6d4a-a68f-4655-91c5-7461627848a1": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
}
}
},
{
"StepId": "b48d3e4d-f0d1-40f4-b433-ec2029750e2b",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"91399eea-b2c1-43b9-a2a3-dde87573d5a8": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
},
"ab5b6d4a-a68f-4655-91c5-7461627848a1": {
"TaskId": "382768f8-68fa-4f6f-8aa5-d00d57b166c5",
"Status": 0,
"Comments": [
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
},
{
"Id": "f205030a-576a-4844-8bc6-b963b12b75ae",
"UPN": "01c04cf2-1479-42d6-841b-9a7e5477fe31",
"PostDate": "2026-07-21T13:09:15.4306856+00:00",
"Comment": "sample string 4",
"CC": [
"be63751e-adb9-49ea-847e-860da770cba7",
"3d178871-c5b8-48db-b5a4-86856d7057d0"
],
"Users": [
"d8f7d532-e615-4b76-b302-8fdfe5ca8dd8",
"cd447ced-4744-4769-8475-17a7e83f138e"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "a53cd760-955e-416c-b942-acf9c2ae22a0",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "a53cd760-955e-416c-b942-acf9c2ae22a0",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "9a82d5f9-7b88-4838-b949-73bd27ece254",
"ConfigId": "ef63be7e-22ba-446e-912b-fce8f10a395d"
}