POST api/mpp/createplan?template={template}&PlanId={PlanId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| template | string |
Required |
|
| 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": "1a20bd76-711a-4397-abbb-ddc955dfaec5",
"Created": "2024-12-12T14:37:48.8939135+00:00",
"Modified": "2024-12-12T14:37:48.8939135+00:00",
"Editor": "11653810-f8a1-401e-b665-cd75c44f3f3d",
"PlannerTypeId": "fcc99d3c-aa87-48ca-b686-8033722c89f0",
"ParentPlanId": "8673a735-12e5-40b2-a9ef-e93520c94a31",
"PortfolioParentId": "29da8a37-182a-42db-ac71-875323bb7267",
"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": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
],
"LastComment": "2024-12-12T14:37:48.8939135+00:00",
"Integrations": [
{
"IntegrationId": "d805d7a9-e889-4b2b-a879-add3f85c9167",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "daef47f5-7d77-4f43-9910-ac2e469f0e28",
"LastExport": "2024-12-12T14:37:48.8939135+00:00",
"LastImport": "2024-12-12T14:37:48.8939135+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "d805d7a9-e889-4b2b-a879-add3f85c9167",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "daef47f5-7d77-4f43-9910-ac2e469f0e28",
"LastExport": "2024-12-12T14:37:48.8939135+00:00",
"LastImport": "2024-12-12T14:37:48.8939135+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2024-12-12T14:37:48.8939135+00:00",
"StatusReportId": "55d71abb-b87c-4708-8953-b2d39dc19168",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2024-12-12T14:37:48.8939135+00:00",
"StatusReportId": "55d71abb-b87c-4708-8953-b2d39dc19168",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"ea6fca4d-e043-4856-a10b-3075a1cbfc9d",
"a249c0d6-efab-404c-ba25-c663acb3f216"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "213b5cff-7bc6-4e7b-8134-c825bf428a56",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2024-12-12T14:37:48.8939135+00:00",
"End": "2024-12-12T14:37:48.8939135+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2024-12-12T14:37:48.8939135+00:00",
"End": "2024-12-12T14:37:48.8939135+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "c09fc8f2-3b9c-437a-9807-01f9628f640c",
"BaseRate": 2.0
},
{
"ResourceId": "c09fc8f2-3b9c-437a-9807-01f9628f640c",
"BaseRate": 2.0
}
]
},
{
"Id": "213b5cff-7bc6-4e7b-8134-c825bf428a56",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2024-12-12T14:37:48.8939135+00:00",
"End": "2024-12-12T14:37:48.8939135+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2024-12-12T14:37:48.8939135+00:00",
"End": "2024-12-12T14:37:48.8939135+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "c09fc8f2-3b9c-437a-9807-01f9628f640c",
"BaseRate": 2.0
},
{
"ResourceId": "c09fc8f2-3b9c-437a-9807-01f9628f640c",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "51b9b848-9a1b-499f-9e17-fed5227460ff",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "51b9b848-9a1b-499f-9e17-fed5227460ff",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "154b4111-8d91-4ddc-b864-085e5af789f7",
"LockedBy": "ffdb8ba2-0996-45f5-9ab7-efde5c2ef752",
"LockedDate": "2024-12-12T14:37:48.8939135+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "0037f9fe-26b2-49dc-8098-3333bc7fc8bc",
"CurrentGateId": "42ca84c7-fda0-4055-b386-10fe61e74229",
"EnteredGate": "2024-12-12T14:37:48.8939135+00:00",
"ExitedGate": "2024-12-12T14:37:48.8939135+00:00",
"GateClosed": true,
"StepStarter": "864cf41a-79c5-4bcb-990e-d406ca1b050f",
"StepApprover": "a8f34fc3-8c8b-4d5b-a2d7-365d46354d81",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "069ed48e-81ce-4708-b16e-8a54b306a465",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"fe65ba48-8eb3-4c29-b113-7fe53100982d": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
},
"0e9276b5-5a6a-403a-8df4-fa58e7b0580a": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
}
}
},
{
"StepId": "069ed48e-81ce-4708-b16e-8a54b306a465",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"fe65ba48-8eb3-4c29-b113-7fe53100982d": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
},
"0e9276b5-5a6a-403a-8df4-fa58e7b0580a": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "069ed48e-81ce-4708-b16e-8a54b306a465",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"fe65ba48-8eb3-4c29-b113-7fe53100982d": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
},
"0e9276b5-5a6a-403a-8df4-fa58e7b0580a": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
}
}
},
{
"StepId": "069ed48e-81ce-4708-b16e-8a54b306a465",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ApprovalStates": {
"fe65ba48-8eb3-4c29-b113-7fe53100982d": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
},
"0e9276b5-5a6a-403a-8df4-fa58e7b0580a": {
"TaskId": "d3bd8d31-9633-44d6-9403-47c92bacf2ed",
"Status": 0,
"Comments": [
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
},
{
"Id": "840c4390-b783-4ebf-a0c4-4981045956a2",
"UPN": "f077f7c2-6ef8-4c0f-b0af-8484b948421c",
"PostDate": "2024-12-12T14:37:48.8939135+00:00",
"Comment": "sample string 4",
"CC": [
"8d34fce3-1984-4844-af60-354e9bce4ce4",
"cd82d4ca-f2ce-4059-9697-e554e04e4a06"
],
"Users": [
"7be680c4-b486-4a01-b620-c64ca7d269c3",
"377090f2-f503-47ad-82d0-da2940a946a8"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "c97c6933-00be-4ace-a6aa-dd1aae7d4a21",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "c97c6933-00be-4ace-a6aa-dd1aae7d4a21",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "b51bb794-b027-43db-ae80-e6f7dffbf13d",
"ConfigId": "53b45b87-5883-495f-b1ac-7a941a3cc24f"
}