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": "48388894-e713-46f2-8a98-77eaaf92456e",
"Created": "2025-07-11T12:42:45.3665756+00:00",
"Modified": "2025-07-11T12:42:45.3665756+00:00",
"Editor": "67f6e4c6-682c-424a-a904-84dd172a0786",
"PlannerTypeId": "92bdbd15-2044-40f9-9686-97a1acebb717",
"ParentPlanId": "7146cc21-cdbd-43a1-9c2f-8445e80fc589",
"PortfolioParentId": "99067a7f-5c49-402f-9361-f5331568b201",
"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": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
],
"LastComment": "2025-07-11T12:42:45.3665756+00:00",
"Integrations": [
{
"IntegrationId": "23d88dc4-bcb6-4fe0-a43b-9e133b1c2ed3",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1d6f2070-07cc-4a47-8fec-4e4d2f2239a2",
"LastExport": "2025-07-11T12:42:45.3665756+00:00",
"LastImport": "2025-07-11T12:42:45.3665756+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"IntegrationId": "23d88dc4-bcb6-4fe0-a43b-9e133b1c2ed3",
"ItemUrl": "sample string 2",
"ItemId": "sample string 3",
"TransactionId": "1d6f2070-07cc-4a47-8fec-4e4d2f2239a2",
"LastExport": "2025-07-11T12:42:45.3665756+00:00",
"LastImport": "2025-07-11T12:42:45.3665756+00:00",
"IntegrationVersion": 7,
"Properties": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"Snapshots": [
{
"Date": "2025-07-11T12:42:45.3665756+00:00",
"StatusReportId": "ef6d2cf3-f0af-418c-b844-4d6bbfae60de",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
},
{
"Date": "2025-07-11T12:42:45.3665756+00:00",
"StatusReportId": "ef6d2cf3-f0af-418c-b844-4d6bbfae60de",
"Fields": {
"sample string 1": {},
"sample string 3": {}
}
}
],
"SubPlans": [
"11f7173f-080c-4462-8ac5-6a3fa8b8e2e4",
"64c9c77d-ab30-4177-81ce-9fb81120262d"
],
"PlanNumber": "sample string 14",
"RateTables": [
{
"Id": "b20be6f2-fdc1-4c54-980e-585eb19b02d1",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-11T12:42:45.3665756+00:00",
"End": "2025-07-11T12:42:45.3665756+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-11T12:42:45.3665756+00:00",
"End": "2025-07-11T12:42:45.3665756+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "a79afa55-0b8d-4d54-b856-64892993d7c2",
"BaseRate": 2.0
},
{
"ResourceId": "a79afa55-0b8d-4d54-b856-64892993d7c2",
"BaseRate": 2.0
}
]
},
{
"Id": "b20be6f2-fdc1-4c54-980e-585eb19b02d1",
"Name": "sample string 2",
"Multipliers": [
{
"Start": "2025-07-11T12:42:45.3665756+00:00",
"End": "2025-07-11T12:42:45.3665756+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
},
{
"Start": "2025-07-11T12:42:45.3665756+00:00",
"End": "2025-07-11T12:42:45.3665756+00:00",
"PercentRevenue": 3.0,
"PercentCost": 4.0
}
],
"ResourceRates": [
{
"ResourceId": "a79afa55-0b8d-4d54-b856-64892993d7c2",
"BaseRate": 2.0
},
{
"ResourceId": "a79afa55-0b8d-4d54-b856-64892993d7c2",
"BaseRate": 2.0
}
]
}
],
"Splits": [
{
"Field": "sample string 1",
"Value": "31d8fb41-bf71-4948-b539-e0ea9d328f21",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
},
{
"Field": "sample string 1",
"Value": "31d8fb41-bf71-4948-b539-e0ea9d328f21",
"Split": 3.0,
"Values": {
"sample string 1": 2.0,
"sample string 3": 4.0
}
}
],
"LockInfo": {
"LockedSid": "404411c5-0479-4246-8ed1-4411c9d331bf",
"LockedBy": "b8df4b1e-97ac-4148-bb22-a60ac20f0e09",
"LockedDate": "2025-07-11T12:42:45.3665756+00:00"
},
"LastLocation": "sample string 15",
"StageGateFlow": {
"Id": "fb7daf18-7fff-4b20-8f4d-c46b74f4cb75",
"CurrentGateId": "fca9ff96-39b7-4320-bf3a-6e721d53ea56",
"EnteredGate": "2025-07-11T12:42:45.3665756+00:00",
"ExitedGate": "2025-07-11T12:42:45.3665756+00:00",
"GateClosed": true,
"StepStarter": "a655cb7a-b866-46ab-9251-c1cee23739b3",
"StepApprover": "cccd416d-997f-4c96-ad80-93ffff879cbf",
"ApprovalState": 0,
"StepState": 0,
"Comments": "sample string 8",
"Approvals": [
{
"StepId": "47e5696b-4f71-417d-ae05-cf902e0998f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"be9ec62a-b44c-4108-9288-d4a848ef1d3c": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
},
"81f351de-96f5-4cf2-8972-ead97d2d4696": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
}
}
},
{
"StepId": "47e5696b-4f71-417d-ae05-cf902e0998f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"be9ec62a-b44c-4108-9288-d4a848ef1d3c": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
},
"81f351de-96f5-4cf2-8972-ead97d2d4696": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
}
}
}
],
"ApprovalsLog": [
{
"StepId": "47e5696b-4f71-417d-ae05-cf902e0998f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"be9ec62a-b44c-4108-9288-d4a848ef1d3c": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
},
"81f351de-96f5-4cf2-8972-ead97d2d4696": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
}
}
},
{
"StepId": "47e5696b-4f71-417d-ae05-cf902e0998f6",
"AutoApproved": true,
"Completed": true,
"Expired": true,
"ExpiredReason": "sample string 5",
"ApprovalStates": {
"be9ec62a-b44c-4108-9288-d4a848ef1d3c": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
},
"81f351de-96f5-4cf2-8972-ead97d2d4696": {
"TaskId": "27e40ce3-4411-4d93-a660-a914993e2439",
"Status": 0,
"Comments": [
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
},
{
"Id": "283dbb5e-d7ec-4bc4-874e-74013321b77f",
"UPN": "c6382043-932f-4ccd-8f67-36c3e0e50d72",
"PostDate": "2025-07-11T12:42:45.3665756+00:00",
"Comment": "sample string 4",
"CC": [
"54559d76-f376-444e-bd0c-1c983efb50da",
"aff7bd21-66ea-476b-bf94-895beb811815"
],
"Users": [
"1a34975c-aff6-4272-96cf-816f69e55e62",
"c4e56195-35ac-42f2-abb2-7919df5f9d1f"
]
}
]
}
}
}
],
"RulesRejected": [
{
"Id": "536c1447-7c63-4cf2-8575-5be4a2577cb7",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
},
{
"Id": "536c1447-7c63-4cf2-8575-5be4a2577cb7",
"Name": "sample string 2",
"FailureText": "sample string 3",
"Filter": "sample string 4"
}
],
"ApprovalRejectionOrFailReason": "sample string 9"
},
"id": "b5ef4fcf-9a4d-4d56-bd10-8213e29b8b17",
"ConfigId": "5b04a0e7-64a6-42b4-baa5-d36b33185b2a"
}