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": "18e71ad3-9ded-4568-8ce6-bc4e49928fa4",
"Created": "2025-10-16T14:31:23.4905091+00:00",
"Modified": "2025-10-16T14:31:23.4905091+00:00",
"Editor": "1be1da3d-1924-4943-a5f0-6208cb35282c",
"PlannerTypeId": "5f20e84d-890b-43e1-af11-830be9a356d4",
"ParentPlanId": "3286eeb5-e31f-4b87-b766-2f247ad5c516",
"PortfolioParentId": "c3ed26e3-79b0-44e4-a7a7-5830d84f9263",
"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": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
],
"LastComment": "2025-10-16T14:31:23.4905091+00:00",
"Integrations": [
{
"IntegrationId": "8acdd521-dc5d-4980-9231-6b19d86bcc89",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "3179c239-3d25-471b-9394-fe2189a8b013",
"LastExport": "2025-10-16T14:31:23.4905091+00:00",
"LastImport": "2025-10-16T14:31:23.4905091+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "8acdd521-dc5d-4980-9231-6b19d86bcc89",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "3179c239-3d25-471b-9394-fe2189a8b013",
"LastExport": "2025-10-16T14:31:23.4905091+00:00",
"LastImport": "2025-10-16T14:31:23.4905091+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-10-16T14:31:23.4905091+00:00",
"StatusReportId": "7c7d5680-02fe-42a7-b21a-891332b4da10",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-10-16T14:31:23.4905091+00:00",
"StatusReportId": "7c7d5680-02fe-42a7-b21a-891332b4da10",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"6d1eebcf-42c9-446f-ad80-017cce004697",
"ce616740-e459-4dde-9a3c-603f4fabcf50"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "a04b320d-e1d7-4e36-8606-dbfbe8f546fa",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-16T14:31:23.4905091+00:00",
"End": "2025-10-16T14:31:23.4905091+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-16T14:31:23.4905091+00:00",
"End": "2025-10-16T14:31:23.4905091+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "6cc6bdd0-89da-4c04-a08f-a300359e4f9d",
"BaseRate": 2.0
},
{
"ResourceId": "6cc6bdd0-89da-4c04-a08f-a300359e4f9d",
"BaseRate": 2.0
}
]
},
{
"Id": "a04b320d-e1d7-4e36-8606-dbfbe8f546fa",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-10-16T14:31:23.4905091+00:00",
"End": "2025-10-16T14:31:23.4905091+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-10-16T14:31:23.4905091+00:00",
"End": "2025-10-16T14:31:23.4905091+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "6cc6bdd0-89da-4c04-a08f-a300359e4f9d",
"BaseRate": 2.0
},
{
"ResourceId": "6cc6bdd0-89da-4c04-a08f-a300359e4f9d",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "258004eb-493b-4eb2-97c8-0ee941a1dce1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "258004eb-493b-4eb2-97c8-0ee941a1dce1",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "086935c4-a416-4f6f-97a8-e7c40cc6dd84",
"LockedBy": "66429387-dbee-44f9-bc3e-7428fa918499",
"LockedDate": "2025-10-16T14:31:23.4905091+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "16a61ad9-aaa7-4bc1-a9ae-a7b95745e0ee",
"CurrentGateId": "0ac25328-781f-4c74-b5cd-d33439d59410",
"EnteredGate": "2025-10-16T14:31:23.4905091+00:00",
"ExitedGate": "2025-10-16T14:31:23.4905091+00:00",
"GateClosed": true,
"StepStarter": "1f9c93b1-2b31-497d-81f5-2066e14cb268",
"StepApprover": "1f7b766b-0ee5-4386-af48-16e51869bfd8",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "7820992e-c83b-4ec1-a68b-b67610e55c8d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"aa55d6ef-3fb9-45f5-9617-96d3a15e470a": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
},
"7aa1c1d6-36b3-4eb1-b72d-e6fa388a16b4": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
}
}
},
{
"StepId": "7820992e-c83b-4ec1-a68b-b67610e55c8d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"aa55d6ef-3fb9-45f5-9617-96d3a15e470a": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
},
"7aa1c1d6-36b3-4eb1-b72d-e6fa388a16b4": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "7820992e-c83b-4ec1-a68b-b67610e55c8d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"aa55d6ef-3fb9-45f5-9617-96d3a15e470a": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
},
"7aa1c1d6-36b3-4eb1-b72d-e6fa388a16b4": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
}
}
},
{
"StepId": "7820992e-c83b-4ec1-a68b-b67610e55c8d",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"aa55d6ef-3fb9-45f5-9617-96d3a15e470a": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
},
"7aa1c1d6-36b3-4eb1-b72d-e6fa388a16b4": {
"TaskId": "9bde1a53-c874-471e-a78a-993a8e1e745f",
"Status": 0,
"Comments": [
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
},
{
"Id": "62be9439-d051-4c22-bf1a-17e4e11e200e",
"UPN": "ee6ebd18-b356-464b-8cf4-a010ccffb7d9",
"PostDate": "2025-10-16T14:31:23.4905091+00:00",
"Comment": "sample string 4",
"CC": [
"f7a72bce-d41f-4b7d-9969-04cf609b0595",
"43327831-c9a2-42a7-8285-e5ab65e35489"
],
"Users": [
"65925beb-1653-4f74-8c9d-952c616782b7",
"4548f061-31e1-42b9-b12b-17795cf8d43b"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "5f9008a6-bbd0-4662-b71f-8863fb4485d0",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "5f9008a6-bbd0-4662-b71f-8863fb4485d0",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "eb6f389b-9560-4ab6-95e1-54c7d96d4dde",
"ConfigId": "c85be966-eacf-4d38-a523-e9e5269815e8"
}