GET api/workplan/{PlanId}
Get workplan by id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PlanId | globally unique identifier |
Required |
Body Parameters
None.
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": "f9e64e1f-87bc-4c73-bac3-20728ae06d53",
"Created": "2025-04-04T02:39:51.6271138+00:00",
"Modified": "2025-04-04T02:39:51.6271138+00:00",
"Editor": "5c43472a-37f1-43cd-bb04-6e9243e63e08",
"PlannerTypeId": "0b1c2665-4a93-4192-abf3-916e86eed4a7",
"ParentPlanId": "86868cf9-d105-4e89-920b-76272de7ba22",
"PortfolioParentId": "fa0401a3-e308-4942-b736-b476c50f85b9",
"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": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
],
"LastComment": "2025-04-04T02:39:51.6271138+00:00",
"Integrations": [
{
"IntegrationId": "4ffac032-22d1-4c80-b313-fec898d7bf25",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e9105ced-0c8e-4ec6-8cb5-2b4ece9b0186",
"LastExport": "2025-04-04T02:39:51.6271138+00:00",
"LastImport": "2025-04-04T02:39:51.6271138+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "4ffac032-22d1-4c80-b313-fec898d7bf25",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "e9105ced-0c8e-4ec6-8cb5-2b4ece9b0186",
"LastExport": "2025-04-04T02:39:51.6271138+00:00",
"LastImport": "2025-04-04T02:39:51.6271138+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-04-04T02:39:51.6271138+00:00",
"StatusReportId": "10a05dee-48c7-4f34-9eac-86f882ce853e",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-04-04T02:39:51.6271138+00:00",
"StatusReportId": "10a05dee-48c7-4f34-9eac-86f882ce853e",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"b40d7fa9-d5fe-42e2-9be4-23553dec4309",
"619fa39e-00cb-402d-afc4-c8c6c2d8bdd9"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "bcec90e3-746d-41a9-bc65-0e35f75286cb",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:39:51.6271138+00:00",
"End": "2025-04-04T02:39:51.6271138+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:39:51.6271138+00:00",
"End": "2025-04-04T02:39:51.6271138+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "8511eca6-14b8-44f4-96e1-79f7902edd90",
"BaseRate": 2.0
},
{
"ResourceId": "8511eca6-14b8-44f4-96e1-79f7902edd90",
"BaseRate": 2.0
}
]
},
{
"Id": "bcec90e3-746d-41a9-bc65-0e35f75286cb",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-04-04T02:39:51.6271138+00:00",
"End": "2025-04-04T02:39:51.6271138+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-04-04T02:39:51.6271138+00:00",
"End": "2025-04-04T02:39:51.6271138+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "8511eca6-14b8-44f4-96e1-79f7902edd90",
"BaseRate": 2.0
},
{
"ResourceId": "8511eca6-14b8-44f4-96e1-79f7902edd90",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "255b26a9-c087-40eb-8aae-f510caf78eb1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "255b26a9-c087-40eb-8aae-f510caf78eb1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "84c5bd4d-1d5c-42ed-b435-e3bafea3e920",
"LockedBy": "388eca30-f868-44ff-bf5c-dc1fc00e60dd",
"LockedDate": "2025-04-04T02:39:51.6271138+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "8f9fc630-0dd2-48bc-b2d6-1bf341af8679",
"CurrentGateId": "b86e3f32-e49a-4e04-aa32-bf65fe1582c3",
"EnteredGate": "2025-04-04T02:39:51.6271138+00:00",
"ExitedGate": "2025-04-04T02:39:51.6271138+00:00",
"GateClosed": true,
"StepStarter": "7703e98a-5fb9-44ca-88e4-4364f29875fd",
"StepApprover": "93fa4841-0df3-46d1-9423-da998922c0bb",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "47affcf5-702f-44d6-8ff6-16d30c633da3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2c205bb9-71c1-4a8c-82f6-a211fab1dc8a": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
},
"34e720c2-e2f9-409e-aa06-5b42dd39e309": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
}
}
},
{
"StepId": "47affcf5-702f-44d6-8ff6-16d30c633da3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2c205bb9-71c1-4a8c-82f6-a211fab1dc8a": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
},
"34e720c2-e2f9-409e-aa06-5b42dd39e309": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "47affcf5-702f-44d6-8ff6-16d30c633da3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2c205bb9-71c1-4a8c-82f6-a211fab1dc8a": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
},
"34e720c2-e2f9-409e-aa06-5b42dd39e309": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
}
}
},
{
"StepId": "47affcf5-702f-44d6-8ff6-16d30c633da3",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"2c205bb9-71c1-4a8c-82f6-a211fab1dc8a": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
},
"34e720c2-e2f9-409e-aa06-5b42dd39e309": {
"TaskId": "626add89-6699-42b1-8015-4fd33f2255c8",
"Status": 0,
"Comments": [
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
},
{
"Id": "181410b8-c09e-4207-af39-73524e15fa51",
"UPN": "d4a4657b-90da-4c36-8bb5-ee6eb4fa86ac",
"PostDate": "2025-04-04T02:39:51.6271138+00:00",
"Comment": "sample string 4",
"CC": [
"d4e2278a-56b4-4f2a-9f26-eb3c60e751f9",
"a1bdefaa-8092-4c65-b757-647f5bbc2c6c"
],
"Users": [
"6b2afbf1-ec2b-4ac8-84b0-96b452a48203",
"dcde368a-2bb4-4ed0-a495-76dcb79d0918"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "a16efa44-254e-4892-9b00-511f267d7fbb",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "a16efa44-254e-4892-9b00-511f267d7fbb",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "45a8e032-7dfb-495a-ab68-ba54c8f3bea3",
"ConfigId": "a69aaf8a-024c-48fd-87af-72132410b19c"
}