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": "f80b4b20-f4fc-4569-853d-6db72c8de354",
"Created": "2025-07-08T19:35:20.3939444+00:00",
"Modified": "2025-07-08T19:35:20.3939444+00:00",
"Editor": "c785e1e3-f52c-42f0-8cbb-5e6740f32027",
"PlannerTypeId": "1c77f461-07ac-4341-867a-055bdc979912",
"ParentPlanId": "7978632d-3290-4599-af54-8a635a05d25b",
"PortfolioParentId": "28907f96-2d20-47d0-b0cd-879ec0ac1195",
"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": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
],
"LastComment": "2025-07-08T19:35:20.3939444+00:00",
"Integrations": [
{
"IntegrationId": "59615be8-4a51-490b-826f-c888ba1d7abc",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "b608d18b-0e74-43f1-adff-8947b11718e2",
"LastExport": "2025-07-08T19:35:20.3939444+00:00",
"LastImport": "2025-07-08T19:35:20.3939444+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "59615be8-4a51-490b-826f-c888ba1d7abc",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "b608d18b-0e74-43f1-adff-8947b11718e2",
"LastExport": "2025-07-08T19:35:20.3939444+00:00",
"LastImport": "2025-07-08T19:35:20.3939444+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-08T19:35:20.3939444+00:00",
"StatusReportId": "2d052de3-0481-42ab-985d-16af6bda2530",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-08T19:35:20.3939444+00:00",
"StatusReportId": "2d052de3-0481-42ab-985d-16af6bda2530",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"fb836cac-e627-46c5-8456-582ff16e248a",
"8bb95c07-041b-46cb-be4f-23c5cfdfe5c9"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "536eb93c-34d4-477b-a4ba-e3dca91f8c74",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T19:35:20.3939444+00:00",
"End": "2025-07-08T19:35:20.3939444+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T19:35:20.3939444+00:00",
"End": "2025-07-08T19:35:20.3939444+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "997c78e9-aeed-4096-833e-08817a6d4139",
"BaseRate": 2.0
},
{
"ResourceId": "997c78e9-aeed-4096-833e-08817a6d4139",
"BaseRate": 2.0
}
]
},
{
"Id": "536eb93c-34d4-477b-a4ba-e3dca91f8c74",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-08T19:35:20.3939444+00:00",
"End": "2025-07-08T19:35:20.3939444+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-08T19:35:20.3939444+00:00",
"End": "2025-07-08T19:35:20.3939444+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "997c78e9-aeed-4096-833e-08817a6d4139",
"BaseRate": 2.0
},
{
"ResourceId": "997c78e9-aeed-4096-833e-08817a6d4139",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "901c43fa-80aa-424e-895a-688347338d50",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "901c43fa-80aa-424e-895a-688347338d50",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "7333291f-a02d-4837-af59-e5f60427d3da",
"LockedBy": "61972dd0-88da-4ba4-84eb-3a701715fa71",
"LockedDate": "2025-07-08T19:35:20.3939444+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "eeafe1b1-3ec8-4061-a88f-29908330c343",
"CurrentGateId": "2e1b9fbe-4c1e-4275-a4ee-38adb8f9a09a",
"EnteredGate": "2025-07-08T19:35:20.3939444+00:00",
"ExitedGate": "2025-07-08T19:35:20.3939444+00:00",
"GateClosed": true,
"StepStarter": "23a9c6a0-68bb-4583-a767-aff903e3c807",
"StepApprover": "ad25d537-4ba3-4eb6-953c-e2b81e06deeb",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "f16bf22d-1efc-4119-81f7-d30918b9fb65",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6c84836e-f995-4b9f-9230-58f980649c10": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
},
"0dfe9940-4258-468f-829f-100c12772250": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
}
}
},
{
"StepId": "f16bf22d-1efc-4119-81f7-d30918b9fb65",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6c84836e-f995-4b9f-9230-58f980649c10": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
},
"0dfe9940-4258-468f-829f-100c12772250": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "f16bf22d-1efc-4119-81f7-d30918b9fb65",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6c84836e-f995-4b9f-9230-58f980649c10": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
},
"0dfe9940-4258-468f-829f-100c12772250": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
}
}
},
{
"StepId": "f16bf22d-1efc-4119-81f7-d30918b9fb65",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"6c84836e-f995-4b9f-9230-58f980649c10": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
},
"0dfe9940-4258-468f-829f-100c12772250": {
"TaskId": "cd21779b-f7da-4fe8-9921-cf90c8da7bc5",
"Status": 0,
"Comments": [
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
},
{
"Id": "3411e781-75d9-4285-8efa-81ae25583e83",
"UPN": "ff7e44f9-7477-4ee5-9933-18dd828e7ce5",
"PostDate": "2025-07-08T19:35:20.3939444+00:00",
"Comment": "sample string 4",
"CC": [
"9ec5da40-ba52-4d93-8a96-21a77125c638",
"f34aa50c-e0ca-469e-b83a-8c0e23df7f80"
],
"Users": [
"795b00d2-1952-4e91-981d-9f0a06df692c",
"a05c732b-81dc-467c-abf9-44d985e2559b"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "460281bf-c689-4864-90c6-3b8953034d15",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "460281bf-c689-4864-90c6-3b8953034d15",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "951d2f4b-13b4-4384-901a-88b1ee04136f",
"ConfigId": "0d018ad7-3511-4460-b783-6c73a3f8ac55"
}