Meisterplan (Preview)

Meisterplan is a portfolio-level resource management tool that helps portfolio and resource managers manage people across teams and initiatives whether your work is traditional, agile or hybrid. Use it to make confident portfolio decisions and interactively surface and solve resource conflicts.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Meisterplan Support
URL https://help.meisterplan.com/
Email support@meisterplan.com
Connector Metadata
Publisher Meisterplan
Website https://meisterplan.com
Privacy policy https://meisterplan.com/privacy-and-data-protection/
Categories Business Management;Business Intelligence

Meisterplan is a portfolio-level resource management tool that helps portfolio and resource managers manage people across teams and initiatives whether your work is traditional, agile or hybrid. Use it to make confident portfolio decisions and interactively surface and solve resource conflicts. See resource availability and capacity, gain visibility into projects, prioritize and align project portfolios to strategies, and generate real-time scenario simulations with Meisterplan. By using the Meisterplan Connector, you can integrate Meisterplan with all the tools your teams use so no one has to do double maintenance on project data. Whether you need to update a project or put in an approved time-off request, Meisterplan and the Meisterplan Connector can make the process seamless.

Prerequisites

To use the Meisterplan connector, you need a Meisterplan account. To get started with Meisterplan, either Request A Demo or Take A Trial.

How to get credentials

When using the Meisterplan Connector, a login dialog pops up that requires you to select the region where your Meisterplan system is located in (either US or EU). Next, enter your credentials for Meisterplan, i.e., username and password, and click Login. Then, click Authorize to allow the connector to access your Meisterplan system.

Get started with your connector

Common use cases are:

  • Updating Project Information: If you make a change to a project in a project management tool (e.g., Trello) such as updating the status, the corresponding project in Meisterplan is automatically updated.
  • Syncing Allocations: If you edit an allocation in an online spreadsheet such as MS Excel, the corresponding allocation in Meisterplan is automatically updated.
  • Keeping Your Resource Absences up to Date: If you approve a time-off request from one of your employees in an online spreadsheet such as Excel, the corresponding resource entry in Meisterplan is automatically updated.
  • Adding New Projects to Meisterplan: If you add a new project in one of your tools, a new project is automatically created in Meisterplan.
  • Adding New Resources to Meisterplan: If you update your online spreadsheet with a new employee, they are automatically added to the Resource Pool in Meisterplan.
  • Regularly Updating Employee Data: If you change a resource's address in your online spreadsheet, the corresponding resource entry in Meisterplan is automatically updated.

Known issues and limitations

  • This connector does not yet support triggers.
  • Webhooks for the Meisterplan REST API do not yet exist but will come soon.

Common errors and remedies

The Meisterplan Connector uses the Meisterplan REST API. A description including status codes can be found in the REST API documentation. Additional information can be found in the Help Center.

FAQ

  • Which Meisterplan user rights do I need to be able to use the connector?

    • Your Meisterplan user needs to have the Access Meisterplan APIs and Connect External Applications right.
    • Your Meisterplan user needs to have read and edit rights for the fields you want to read or update using the connector.
  • Can I use the connector with the Meisterplan Basic edition?

    • Yes, the connector is supported by all Meisterplan editions.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Region string Region of your hosted Meisterplan system True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Business goals

Returns all business goals

Create a Milestone Dependency

Returns the id of the newly created milestone dependency

Create Calendars

Create a calendar with the given data. Will return the newly created calendar.

Create Financials

Returns the newly created financial event.

Create Milestones

Returns the newly created milestone

Create OBS Type

Creates an OBS type with the given data. Will return the newly created OBS type.

Create OBS Unit

Creates an OBS unit with the given data. Will return the newly created OBS unit.

Create or Update Actual Time Worked

This endpoint lets you create new Actual Time Worked and update the existing Actual Time Worked of a project by an entity (resource or role). We will not update Actual Time Worked for booking dates that are not specified in the request for a given project and entity. With the mode property you can control if an existing Actual Time Worked value is replaced by the new value or if its value is added to the booking in the request.Please note that actual time worked data itself is independent from its scenario. It will be the same across all scenarios for a given project.

Create or Update Allocations

This endpoint lets you create new allocations and update existing allocations of a project. Changes will only be made for the specified date ranges as well as the specified resources and roles.

Create Programs

Creates a program with the given fields and returns the newly created program.

Create Projects

Creates a project with the given fields and returns the newly created project.

Notes:

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Custom Fields

Custom fields are defined AS PROPERTIES OF the customFields object. The property name of a custom field corresponds to its column name. A custom field is an object containing a value. The value can be of type string, number or boolean depending on the type of custom field. You can view all available custom fields with their respective column names in your Meisterplan system.

For custom fields of type string, text, lookup or url, the value is of JSON type string. For custom fields of type integer, decimal or currency, the value is of JSON type float. For custom fields of type boolean, the value is of JSON type boolean.

Example:

"customFields":{       "cust_stage_gate":{         "value": "New"       }       ...     }

Priorities

Projects may be assigned to a program, or they can be given a rank category. It is not possible to assign a project to a rank category and a program at the same time. Assigning an existing project to a rank category will unassign it from any program it may be assigned to. Assigning an existing project to a program may mean that its rank category changes, if the target program is in a different rank category.

It is currently not possible to prioritize projects within a program.

Create Resources

Creates a resource by the given fields and returns the newly created.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Create Roles

Returns the created role on success.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Delete Actual Time Worked

Deletes all actual time worked of a given project.

Delete Allocations

Deletes an allocation in a given project of a scenario.

Delete an OBS Type by ID

Delete the OBS type specified by the given ID. If the OBS type with the given ID does not exist, the request will fail.

Delete an OBS Unit by ID

Deletes the OBS unit specified by the given ID. If the OBS unit with the given ID does not exist, the request will fail.

Delete Calendars

Deletes a calendar in your Meisterplan system. Please note that the default calendar or a parent of the default calendar cannot be deleted.

Delete Financials

Deletes a financial event in a given project of a scenario.

Delete Milestone Dependencies

Deletes a milestone dependency in a given scenario.

Delete Milestones

Deletes a milestone in a given project of a scenario.

Delete Programs

Deletes a program specified by the given ID.

Delete Projects

Deletes a project in a given scenario.

Delete Resources

Delete the resource specified by the given ID. If the resource with the given ID does not exist, the request fails.

Delete Roles

Delete the role specified by the given ID. If the role with the given ID does not exist, the request will fail.

Get a List of Actual Time Worked

Returns a list of actual time worked for all projects of a specific scenario. Please note that actual time worked data itself is independent from its scenario.

Get a List of Allocations

Returns a list of allocations of a project

Get a List of Calendar Exceptions

Get a list of all exceptions to this calendar in your Meisterplan system.

Get a List of Calendars

Get a list of all calendars in your Meisterplan system.

Get a List of Financials

Returns a list of financials of a project

Get a List of Milestone Dependencies

Returns a list of milestones dependencies of a scenario

Get a List of Milestones

Returns a list of milestones of a project

Get a List of Portfolios

Returns a list of all available portfolios. If you do not have the right to view any portfolio, Returns a list of all available portfolios that you have the right to access via your API token. If you do not have the right to view any portfolio, an empty list will be returned.

Get a List of Programs

Returns a list of programs in the given scenario

Get a List of Projects

This endpoint is paginated. It returns a list of projects up to the specified PAGESIZE

Get a List of Resources

This endpoint is paginated. It returns a list of resources up to the specified PAGESIZE

Get a List of Roles

Returns a list of all available roles. If no roles are available, an empty list is returned.

Get a List of Scenarios

It returns a list of scenarios

Get all OBS Types

This endpoint is for OBS types only. To get OBS units, use /obsTypes//obsUnits

Get all OBS Units

This endpoint returns a list of all OBS units for the given OBS type.

Get Allocations by ID

Returns the individual allocation specified by the given ID.

Get an OBS Type by ID

This endpoint is for OBS types only. To get OBS units, use /obsTypes//obsUnits

Get an OBS Unit

This endpoint returns a single OBS unit.

Get Calendars by ID

Get one calendar in your Meisterplan system. Use the special ID defaultCalendar to get the default calendar.

Get Deviations from the Calendar

Reads deviations to the resource's calendar working hours. If no start and finish values are passed, all deviations of the requested resource are returned. If only start is passed, all deviations starting from this time are returned. If only finish is passed, all deviations up to that point are returned.

Get Financials by ID

Returns the individual financial event specified by the given ID.

Get Milestones by ID

Returns the individual milestone specified by the given ID.

Get Projects by ID

Returns the individual project specified by the given ID.

Get Resources by ID

Returns the individual resource specified by the given ID.

Get Roles by ID

Returns the individual role specified by the given ID.

Get Scenarios by ID

Returns the individual scenario specified by the given ID. HINT: You can use "planOfRecord" as the ID for the plan of record scenario.

Get the capacity segments of a role

Returns the capacity segments for the role specified by the given ID. Returns an empty list if no capacity segments exist.

Get the capacity segments of all roles

Returns the capacity segments for all roles. If no capacity segments exist for a given role, its role capacities will be empty.

Replace Allocations

This endpoint lets you replace all allocations of a project. The result will be the same as if all existing allocations are deleted and the passed allocations are created again.

Replace Financials

Replaces financial events of a given project within a scenario.

Replace Milestones

Replaces milestones of a given project within a scenario.

Set Default Calendar

Sets an existing calendar as the default calendar in your Meisterplan system.

Update Allocations

This endpoint lets you update existing allocations of a project. Changes will only be made for the specified date ranges as well as the specified resources and roles.

Update an OBS Unit

Updates a single OBS unit's name or moves it to a different parent.

Update Calendar Exceptions

Use this request to replace all calendar exceptions for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar exceptions with the exceptions property. Note that all exceptions in the specified period will be overwritten by the exceptions listed in the exceptions property.

  • If null is used for the start period and end period, all exceptions of the calendar are overwritten - If only the start date of the period is defined, all exceptions starting from this time will be overwritten - If only the end date of the period is defined, all exceptions up to that point will be overwritten - If an exception is removed and a parent calendar has an exception at that date, this calendar inherits the exception from the parent calendar.
Update Calendars

Perform an update on a calendar specified by the given ID.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Update Deviations from the Calendar

Use this request to replace all calendar deviations of a resource for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar deviations with the deviations property. Note that all deviations in the specified period will be overwritten by the deviations listed in the deviations property.

  • If null is used for the start period and end period, all calendar deviations of the resource are overwritten - If only the start date of the period is defined, all deviations starting from this time will be overwritten - If only the end date of the period is defined, all deviations up to that point will be overwritten - If null is used for the start and/or end date of a calendar deviation, the deviation is assumed to last from or until the root start or finish date specified above.

All deviations are flattened into a sequential structure. Cases of overlapping deviations will be resolved by giving precedence to deviations occurring later in the array.

Update Financials

Updates a financial event by ID in a given project of a scenario.

Update Milestones

Perform an update on a milestone specified by the given ID.

Update OBS Types

Performs an update on an OBS type specified by the given ID.

Update Priorities

This endpoint updates the priorities of projects and programs. Please consider that updating the priority of a project that is within a program results in unassigning the project from its program.To update the priorities of your projects and programs, list their IDs in the desired order of priority for each rank category. If there are projects or programs in Meisterplan for a particular rank category that are not mentioned in your list, you can use the position parameter to define whether your listed projects and programs will be ranked above or below those in Meisterplan.

Update Programs

Perform an update on a program specified by the given ID.

Update Projects

Perform an update on a project specified by the given ID.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Custom Fields

Custom fields are defined AS PROPERTIES OF the customFields object. The property name of a custom field corresponds to its column name. A custom field is an object containing a value. The value can be of type string, number or boolean depending on the type of custom field. You can view all available custom fields with their respective column names in your Meisterplan system.

For custom fields of type string, text, lookup or url, the value is of JSON type string. For custom fields of type integer, decimal or currency, the value is of JSON type float. For custom fields of type boolean, the value is of JSON type boolean.

Example:

"customFields":{       "cust_stage_gate":{         "value": "New"       }       ...     }

A note on Project Finish

Please consider that an update of the finish date of a project deletes all milestones and allocation segments that exist after the new project finish date.

Update Resources

Perform an update on a resource specified by the given ID.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Update Roles

Perform an update on a role specified by the given ID. To do a partial update, only the updated fields need to be sent. To delete a field value, the field must be sent with an explicit null value. Fields with a default value will be reset to their default when set to null.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Update the capacity segments of a role

Updates the capacity segments for the role specified by the given ID. To erase all capacity segments, send a segment without start or finish and 0 capacity

Business goals

Returns all business goals

Returns

ListResponseOfBusinessGoalDefinitionResponse
ListResponseOfBusinessGoalDefinitionResponse

Create a Milestone Dependency

Returns the id of the newly created milestone dependency

Parameters

Name Key Required Type Description
From Milestone Id
fromMilestoneId True string
To Milestone Id
toMilestoneId True string
ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

MilestoneDependencyCreateResponse
MilestoneDependencyCreateResponse

Create Calendars

Create a calendar with the given data. Will return the newly created calendar.

Parameters

Name Key Required Type Description
Name
name True string
Parent Id
parentId string
Friday
friday double
Monday
monday double
Saturday
saturday double
Sunday
sunday double
Thursday
thursday double
Tuesday
tuesday double
Wednesday
wednesday double

Returns

CalendarResponse
CalendarResponse

Create Financials

Returns the newly created financial event.

Parameters

Name Key Required Type Description
Amount
amount True double
Name
name string

The financials category must exist prior to creation. It will not be implicitly created.

Description
description string
Due Date
dueDate string

Is only valid in combination with on: Date (format: YYYY-MM-DD).

Milestone Id
milestoneId string

Is only valid in combination with on: Milestone. The milestone must exist in the project. It will not be implicitly created.

On
on string

Milestone is only valid in combination with a value in the field milestoneId. Date is only valid in combination with a value in the field dueDate.

Type
type True string
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

FinancialsResponse
FinancialsResponse

Create Milestones

Returns the newly created milestone

Parameters

Name Key Required Type Description
Date
date True string

format: YYYY-MM-DD

Name
name True string
Name
name string

The project phase must exist prior to creation. It will not be implicitly created.

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

MilestoneResponse
MilestoneResponse

Create OBS Type

Creates an OBS type with the given data. Will return the newly created OBS type.

Parameters

Name Key Required Type Description
Name
name True string

Returns

ObsTypeResponse
ObsTypeResponse

Create OBS Unit

Creates an OBS unit with the given data. Will return the newly created OBS unit.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

Name
name True string
Parent Id
parentId string

Returns

ObsUnitResponse
ObsUnitResponse

Create or Update Actual Time Worked

This endpoint lets you create new Actual Time Worked and update the existing Actual Time Worked of a project by an entity (resource or role). We will not update Actual Time Worked for booking dates that are not specified in the request for a given project and entity. With the mode property you can control if an existing Actual Time Worked value is replaced by the new value or if its value is added to the booking in the request.Please note that actual time worked data itself is independent from its scenario. It will be the same across all scenarios for a given project.

Parameters

Name Key Required Type Description
Id
id string

The id of the entity to which this actual time worked entry is linked

Type
type string
Booking Date
bookingDate date

Date of this booking

Hours
hours double

Value in hours

Mode
mode string
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ActualTimeWorkedResponse
ActualTimeWorkedResponse

Create or Update Allocations

This endpoint lets you create new allocations and update existing allocations of a project. Changes will only be made for the specified date ranges as well as the specified resources and roles.

Parameters

Name Key Required Type Description
Id
id string

The id of the entity to which this allocation is linked. Set type to RESOLVE_BY_KEY_OR_NAME to resolve resource keys or role names automatically instead.

Project Role
projectRole string

The role id to which this allocation is linked. This field is only valid in combination with the types RESOURCE or RESOLVE_BY_KEY_OR_NAME. If type is set to RESOLVE_BY_KEY_OR_NAME, projectRole is resolved by name.

Type
type string

Control how the value in the field id is interpreted. RESOURCE resolves resources by UUID. ROLE resolves roles by UUID. RESOLVE_BY_KEY_OR_NAME resolves either resources by resource key or roles by role name.

Days
days double

The request accepts either FTE, hours or days.

Finish
finish date
Fte
fte double

The request accepts either FTE, hours or days.

Hours
hours double

The request accepts either FTE, hours or days.

Start
start date
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

AllocationResponse
AllocationResponse

Create Programs

Creates a program with the given fields and returns the newly created program.

Parameters

Name Key Required Type Description
Name
name True string
ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ProgramResponse
ProgramResponse

Create Projects

Creates a project with the given fields and returns the newly created project.

Notes:

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Custom Fields

Custom fields are defined AS PROPERTIES OF the customFields object. The property name of a custom field corresponds to its column name. A custom field is an object containing a value. The value can be of type string, number or boolean depending on the type of custom field. You can view all available custom fields with their respective column names in your Meisterplan system.

For custom fields of type string, text, lookup or url, the value is of JSON type string. For custom fields of type integer, decimal or currency, the value is of JSON type float. For custom fields of type boolean, the value is of JSON type boolean.

Example:

"customFields":{       "cust_stage_gate":{         "value": "New"       }       ...     }

Priorities

Projects may be assigned to a program, or they can be given a rank category. It is not possible to assign a project to a rank category and a program at the same time. Assigning an existing project to a rank category will unassign it from any program it may be assigned to. Assigning an existing project to a program may mean that its rank category changes, if the target program is in a different rank category.

It is currently not possible to prioritize projects within a program.

Parameters

Name Key Required Type Description
Approved Budget
approvedBudget double
Days
days string

The request accepts either hours or days.

Hours
hours string

The request accepts either hours or days.

Name
name string

Missing values will be created automatically

If you import an unknown value, it will be automatically created for you in Meisterplan.

Cost Type
costType string

default: see Meisterplan documentation.

External Id
externalId string

Must be unique. If empty, value will be generated.

Finish
finish string

format: YYYY-MM-DD

Id
id string
Name
name True string
Notes
notes string
Category
category True string
Position
position True string
Id
id string
Project Key
projectKey string

Must be unique. If empty, value will be generated.

Start
start string

format: YYYY-MM-DD

Value
value string

Missing values will be created automatically

If you import an unknown value, it will be automatically created for you in Meisterplan.

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ProjectResponse
ProjectResponse

Create Resources

Creates a resource by the given fields and returns the newly created.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Parameters

Name Key Required Type Description
Id
id string

default: uses default calendar if path and id are null. If you specify the id to reference a calendar you must omit the path property.

Path
path string

default: uses default calendar if path and id are null. format: See endpoint description. If you specify the path to reference a calendar you must omit the id property.

Cost Per Hour
costPerHour double
Email Address
emailAddress string
Start Date
startDate string

format: YYYY-MM-DD

Termination Date
terminationDate string

format: YYYY-MM-DD

External Id
externalId string

Must be unique. If empty, value will be generated.

External Resource
externalResource boolean

default: false

First Name
firstName string
Last Name
lastName True string
City
city string
Country
country string
Postal Code
postalCode string
Id
id string
Resource Key
resourceKey string

Must be unique. If empty, value will be generated.

Skills
Skills string

Returns

ResourceResponse
ResourceResponse

Create Roles

Returns the created role on success.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Parameters

Name Key Required Type Description
Cost Per Hour
costPerHour double
Cost Type
costType string

default: see Meisterplan documentation.

External Id
externalId string

Must be unique. If empty, value will be generated.

Name
name True string

Returns

RoleResponse
RoleResponse

Delete Actual Time Worked

Deletes all actual time worked of a given project.

Parameters

Name Key Required Type Description
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Allocations

Deletes an allocation in a given project of a scenario.

Parameters

Name Key Required Type Description
AllocationId
allocationId True string

Internal Meisterplan identifier

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete an OBS Type by ID

Delete the OBS type specified by the given ID. If the OBS type with the given ID does not exist, the request will fail.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete an OBS Unit by ID

Deletes the OBS unit specified by the given ID. If the OBS unit with the given ID does not exist, the request will fail.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

ObsUnitId
obsUnitId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Calendars

Deletes a calendar in your Meisterplan system. Please note that the default calendar or a parent of the default calendar cannot be deleted.

Parameters

Name Key Required Type Description
CalendarId
calendarId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Financials

Deletes a financial event in a given project of a scenario.

Parameters

Name Key Required Type Description
FinancialsId
financialsId True string

Internal Meisterplan identifier

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Milestone Dependencies

Deletes a milestone dependency in a given scenario.

Parameters

Name Key Required Type Description
MilestoneDependencyId
milestoneDependencyId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Milestones

Deletes a milestone in a given project of a scenario.

Parameters

Name Key Required Type Description
MilestoneId
milestoneId True string

Internal Meisterplan identifier

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Programs

Deletes a program specified by the given ID.

Parameters

Name Key Required Type Description
ProgramId
programId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Delete Projects

Deletes a project in a given scenario.

Parameters

Name Key Required Type Description
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Resources

Delete the resource specified by the given ID. If the resource with the given ID does not exist, the request fails.

Parameters

Name Key Required Type Description
ResourceId
resourceId True string

Internal Meisterplan identifier

Returns

Unit
object

Delete Roles

Delete the role specified by the given ID. If the role with the given ID does not exist, the request will fail.

Parameters

Name Key Required Type Description
RoleId
roleId True string

Internal Meisterplan identifier

Returns

Unit
object

Get a List of Actual Time Worked

Returns a list of actual time worked for all projects of a specific scenario. Please note that actual time worked data itself is independent from its scenario.

Parameters

Name Key Required Type Description
Filter
filter string

Stringified JSON object with an entity id and that entity's type. The type can be "RESOURCE" or "ROLE". Selects all objects that exactly match the specified properties. Note: take care to URL encode your parameter. { "id": string, "type": string }

PageAfter
pageAfter string

The cursor after which to retrieve results. The cursor can be taken from a preceding request.

PageSize
pageSize integer

Can be between 1 and 100

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

PaginatedResponseOfActualTimeWorkedResponse
PaginatedResponseOfActualTimeWorkedResponse

Get a List of Allocations

Returns a list of allocations of a project

Parameters

Name Key Required Type Description
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfAllocationResponse
ListResponseOfAllocationResponse

Get a List of Calendar Exceptions

Get a list of all exceptions to this calendar in your Meisterplan system.

Parameters

Name Key Required Type Description
CalendarId
calendarId True string

Internal Meisterplan identifier

EndDate
endDate date

endDate

StartDate
startDate date

startDate

Returns

ListResponseOfCalendarExceptionResponse
ListResponseOfCalendarExceptionResponse

Get a List of Calendars

Get a list of all calendars in your Meisterplan system.

Returns

ListResponseOfCalendarResponse
ListResponseOfCalendarResponse

Get a List of Financials

Returns a list of financials of a project

Parameters

Name Key Required Type Description
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfFinancialsResponse
ListResponseOfFinancialsResponse

Get a List of Milestone Dependencies

Returns a list of milestones dependencies of a scenario

Parameters

Name Key Required Type Description
PageAfter
pageAfter string

The cursor after which to retrieve results. The cursor can be taken from a preceding request.

PageSize
pageSize integer

Can be between 1 and 500

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

PaginatedResponseOfMilestoneDependencyResponse
PaginatedResponseOfMilestoneDependencyResponse

Get a List of Milestones

Returns a list of milestones of a project

Parameters

Name Key Required Type Description
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfMilestoneResponse
ListResponseOfMilestoneResponse

Get a List of Portfolios

Returns a list of all available portfolios. If you do not have the right to view any portfolio, Returns a list of all available portfolios that you have the right to access via your API token. If you do not have the right to view any portfolio, an empty list will be returned.

Returns

ListResponseOfPortfolioResponse
ListResponseOfPortfolioResponse

Get a List of Programs

Returns a list of programs in the given scenario

Parameters

Name Key Required Type Description
ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfProgramResponse
ListResponseOfProgramResponse

Get a List of Projects

This endpoint is paginated. It returns a list of projects up to the specified PAGESIZE

Parameters

Name Key Required Type Description
Filter
filter string

Stringified JSON object with a subset of properties of the expected object. Selects all objects that exactly match the specified properties. Projects are searchable by projectKey, name, externalId, programId, portfolioId, and custom fields of the String and Integer type. Integers must be encoded as JSON string. The filter programId = null will yield all projects that are not associated with a program. Furthermore, the filter portfolioId = null will yield all projects. Note: take care to URL encode your parameter. { "projectKey": string, "name": string, "externalId": string, "programId": string, "portfolioId": string, "customFields": { "cust_field_1": string, "cust_field_2": string, .... } }

PageAfter
pageAfter string

The cursor after which to retrieve results. The cursor can be taken from a preceding request.

PageSize
pageSize integer

Can be between 1 and 500

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

PaginatedResponseOfAllProjectsResponse
PaginatedResponseOfAllProjectsResponse

Get a List of Resources

This endpoint is paginated. It returns a list of resources up to the specified PAGESIZE

Parameters

Name Key Required Type Description
Filter
filter string

Stringified JSON object with a subset of properties of the expected object. Selects all objects that exactly match the specified properties. Note: take care to URL encode your parameter. { "resourceKey": string, "lastName": string, "externalId": string, "emailAddress": string, "postalAddress": { "city": string, "country": string, "postalCode": string } }

PageAfter
pageAfter string

The cursor after which to retrieve results. The cursor can be taken from a preceding request.

PageSize
pageSize integer

Can be between 1 and 500

Returns

PaginatedResponseOfResourceResponse
PaginatedResponseOfResourceResponse

Get a List of Roles

Returns a list of all available roles. If no roles are available, an empty list is returned.

Parameters

Name Key Required Type Description
Filter
filter string

Stringified JSON object with a subset of properties of the expected object. Selects all objects that exactly match the specified properties. Note: take care to URL encode your parameter. { "externalId": string, "name": string }

Returns

ListResponseOfRoleResponse
ListResponseOfRoleResponse

Get a List of Scenarios

It returns a list of scenarios

Returns

ListResponseOfScenarioResponse
ListResponseOfScenarioResponse

Get all OBS Types

This endpoint is for OBS types only. To get OBS units, use /obsTypes//obsUnits

Returns

ListResponseOfObsTypeResponse
ListResponseOfObsTypeResponse

Get all OBS Units

This endpoint returns a list of all OBS units for the given OBS type.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

Returns

ListResponseOfObsUnitResponse
ListResponseOfObsUnitResponse

Get Allocations by ID

Returns the individual allocation specified by the given ID.

Parameters

Name Key Required Type Description
AllocationId
allocationId True string

Internal Meisterplan identifier

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

AllocationResponse
AllocationResponse

Get an OBS Type by ID

This endpoint is for OBS types only. To get OBS units, use /obsTypes//obsUnits

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

Returns

ObsTypeResponse
ObsTypeResponse

Get an OBS Unit

This endpoint returns a single OBS unit.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

ObsUnitId
obsUnitId True string

Internal Meisterplan identifier

Returns

ObsUnitResponse
ObsUnitResponse

Get Calendars by ID

Get one calendar in your Meisterplan system. Use the special ID defaultCalendar to get the default calendar.

Parameters

Name Key Required Type Description
CalendarId
calendarId True string

Internal Meisterplan identifier

Returns

CalendarResponse
CalendarResponse

Get Deviations from the Calendar

Reads deviations to the resource's calendar working hours. If no start and finish values are passed, all deviations of the requested resource are returned. If only start is passed, all deviations starting from this time are returned. If only finish is passed, all deviations up to that point are returned.

Parameters

Name Key Required Type Description
Finish
finish date

Finish date for filtering time period

ResourceId
resourceId True string

Internal Meisterplan identifier

Start
start date

Start date for filtering time period

Returns

ListResponseOfCalendarDeviationResponse
ListResponseOfCalendarDeviationResponse

Get Financials by ID

Returns the individual financial event specified by the given ID.

Parameters

Name Key Required Type Description
FinancialsId
financialsId True string

Internal Meisterplan identifier

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

FinancialsResponse
FinancialsResponse

Get Milestones by ID

Returns the individual milestone specified by the given ID.

Parameters

Name Key Required Type Description
MilestoneId
milestoneId True string

Internal Meisterplan identifier

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

MilestoneResponse
MilestoneResponse

Get Projects by ID

Returns the individual project specified by the given ID.

Parameters

Name Key Required Type Description
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ProjectResponse
ProjectResponse

Get Resources by ID

Returns the individual resource specified by the given ID.

Parameters

Name Key Required Type Description
ResourceId
resourceId True string

Internal Meisterplan identifier

Returns

ResourceResponse
ResourceResponse

Get Roles by ID

Returns the individual role specified by the given ID.

Parameters

Name Key Required Type Description
RoleId
roleId True string

Internal Meisterplan identifier

Returns

RoleResponse
RoleResponse

Get Scenarios by ID

Returns the individual scenario specified by the given ID. HINT: You can use "planOfRecord" as the ID for the plan of record scenario.

Parameters

Name Key Required Type Description
ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ScenarioResponse
ScenarioResponse

Get the capacity segments of a role

Returns the capacity segments for the role specified by the given ID. Returns an empty list if no capacity segments exist.

Parameters

Name Key Required Type Description
RoleId
roleId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfRoleCapacityResponse
ListResponseOfRoleCapacityResponse

Get the capacity segments of all roles

Returns the capacity segments for all roles. If no capacity segments exist for a given role, its role capacities will be empty.

Parameters

Name Key Required Type Description
ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfRoleWithRoleCapacityResponse
ListResponseOfRoleWithRoleCapacityResponse

Replace Allocations

This endpoint lets you replace all allocations of a project. The result will be the same as if all existing allocations are deleted and the passed allocations are created again.

Parameters

Name Key Required Type Description
Id
id string

The id of the entity to which this allocation is linked. Set type to RESOLVE_BY_KEY_OR_NAME to resolve resource keys or role names automatically instead.

Project Role
projectRole string

The role id to which this allocation is linked. This field is only valid in combination with the types RESOURCE or RESOLVE_BY_KEY_OR_NAME. If type is set to RESOLVE_BY_KEY_OR_NAME, projectRole is resolved by name.

Type
type string

Control how the value in the field id is interpreted. RESOURCE resolves resources by UUID. ROLE resolves roles by UUID. RESOLVE_BY_KEY_OR_NAME resolves either resources by resource key or roles by role name.

Days
days double

The request accepts either FTE, hours or days.

Finish
finish date
Fte
fte double

The request accepts either FTE, hours or days.

Hours
hours double

The request accepts either FTE, hours or days.

Start
start date
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Replace Financials

Replaces financial events of a given project within a scenario.

Parameters

Name Key Required Type Description
Amount
amount True double
Name
name string

The financials category must exist prior to creation. It will not be implicitly created.

Description
description string
Due Date
dueDate string

Is only valid in combination with on: Date (format: YYYY-MM-DD).

Milestone Id
milestoneId string

Is only valid in combination with on: Milestone. The milestone must exist in the project. It will not be implicitly created.

On
on string

Milestone is only valid in combination with a value in the field milestoneId. Date is only valid in combination with a value in the field dueDate.

Type
type True string
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Replace Milestones

Replaces milestones of a given project within a scenario.

Parameters

Name Key Required Type Description
Date
date True string

format: YYYY-MM-DD

Name
name True string
Name
name string

The project phase must exist prior to creation. It will not be implicitly created.

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Set Default Calendar

Sets an existing calendar as the default calendar in your Meisterplan system.

Parameters

Name Key Required Type Description
Id
id string

Returns

Unit
object

Update Allocations

This endpoint lets you update existing allocations of a project. Changes will only be made for the specified date ranges as well as the specified resources and roles.

Parameters

Name Key Required Type Description
AllocationId
allocationId True string

Internal Meisterplan identifier

Days
days double

The request accepts either FTE, hours or days.

Finish
finish date
Fte
fte double

The request accepts either FTE, hours or days.

Hours
hours double

The request accepts either FTE, hours or days.

Start
start date
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

AllocationResponse
AllocationResponse

Update an OBS Unit

Updates a single OBS unit's name or moves it to a different parent.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

ObsUnitId
obsUnitId True string

Internal Meisterplan identifier

Name
name string
Parent Id
parentId string

Returns

ObsUnitResponse
ObsUnitResponse

Update Calendar Exceptions

Use this request to replace all calendar exceptions for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar exceptions with the exceptions property. Note that all exceptions in the specified period will be overwritten by the exceptions listed in the exceptions property.

  • If null is used for the start period and end period, all exceptions of the calendar are overwritten - If only the start date of the period is defined, all exceptions starting from this time will be overwritten - If only the end date of the period is defined, all exceptions up to that point will be overwritten - If an exception is removed and a parent calendar has an exception at that date, this calendar inherits the exception from the parent calendar.

Parameters

Name Key Required Type Description
CalendarId
calendarId True string

Internal Meisterplan identifier

Date
date date
Description
description string
Working Hours
workingHours double
Finish
finish date
Start
start date

Returns

Unit
object

Update Calendars

Perform an update on a calendar specified by the given ID.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Parameters

Name Key Required Type Description
CalendarId
calendarId True string

Internal Meisterplan identifier

Name
name string
Friday
friday double
Monday
monday double
Saturday
saturday double
Sunday
sunday double
Thursday
thursday double
Tuesday
tuesday double
Wednesday
wednesday double

Returns

CalendarResponse
CalendarResponse

Update Deviations from the Calendar

Use this request to replace all calendar deviations of a resource for a certain time period. This time period can be defined using the root start and finish attributes of the request. Specify the new list of calendar deviations with the deviations property. Note that all deviations in the specified period will be overwritten by the deviations listed in the deviations property.

  • If null is used for the start period and end period, all calendar deviations of the resource are overwritten - If only the start date of the period is defined, all deviations starting from this time will be overwritten - If only the end date of the period is defined, all deviations up to that point will be overwritten - If null is used for the start and/or end date of a calendar deviation, the deviation is assumed to last from or until the root start or finish date specified above.

All deviations are flattened into a sequential structure. Cases of overlapping deviations will be resolved by giving precedence to deviations occurring later in the array.

Parameters

Name Key Required Type Description
Finish
finish date
Relative Capacity
relativeCapacity True double
Start
start date
Finish
finish date
Start
start date
ResourceId
resourceId True string

Internal Meisterplan identifier

Returns

ListResponseOfCalendarDeviationResponse
ListResponseOfCalendarDeviationResponse

Update Financials

Updates a financial event by ID in a given project of a scenario.

Parameters

Name Key Required Type Description
FinancialsId
financialsId True string

Internal Meisterplan identifier

Amount
amount double
Name
name string

The financials category must exist prior to creation. It will not be implicitly created.

Description
description string
Due Date
dueDate string

Is only valid in combination with on: Date (format: YYYY-MM-DD).

Milestone Id
milestoneId string

Is only valid in combination with on: Milestone. The milestone must exist in the project. It will not be implicitly created.

On
on string

Milestone is only valid in combination with a value in the field milestoneId. Date is only valid in combination with a value in the field dueDate.

Type
type string
ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

FinancialsResponse
FinancialsResponse

Update Milestones

Perform an update on a milestone specified by the given ID.

Parameters

Name Key Required Type Description
MilestoneId
milestoneId True string

Internal Meisterplan identifier

Date
date string

format: YYYY-MM-DD

Name
name string
Name
name string

The project phase must exist prior to creation. It will not be implicitly created.

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

MilestoneResponse
MilestoneResponse

Update OBS Types

Performs an update on an OBS type specified by the given ID.

Parameters

Name Key Required Type Description
ObsTypeId
obsTypeId True string

Internal Meisterplan identifier

Name
name True string

Returns

ObsTypeResponse
ObsTypeResponse

Update Priorities

This endpoint updates the priorities of projects and programs. Please consider that updating the priority of a project that is within a program results in unassigning the project from its program.To update the priorities of your projects and programs, list their IDs in the desired order of priority for each rank category. If there are projects or programs in Meisterplan for a particular rank category that are not mentioned in your list, you can use the position parameter to define whether your listed projects and programs will be ranked above or below those in Meisterplan.

Parameters

Name Key Required Type Description
Id
id True string

The id value can be a project or a program.

Position
position string

Position can be FIRST or LAST. FIRST is default

Id
id True string

The id value can be a project or a program.

Position
position string

Position can be FIRST or LAST. FIRST is default

Id
id True string

The id value can be a project or a program.

Position
position string

Position can be FIRST or LAST. FIRST is default

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

Unit
object

Update Programs

Perform an update on a program specified by the given ID.

Parameters

Name Key Required Type Description
Name
name string
ProgramId
programId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ProgramResponse
ProgramResponse

Update Projects

Perform an update on a project specified by the given ID.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Custom Fields

Custom fields are defined AS PROPERTIES OF the customFields object. The property name of a custom field corresponds to its column name. A custom field is an object containing a value. The value can be of type string, number or boolean depending on the type of custom field. You can view all available custom fields with their respective column names in your Meisterplan system.

For custom fields of type string, text, lookup or url, the value is of JSON type string. For custom fields of type integer, decimal or currency, the value is of JSON type float. For custom fields of type boolean, the value is of JSON type boolean.

Example:

"customFields":{       "cust_stage_gate":{         "value": "New"       }       ...     }

A note on Project Finish

Please consider that an update of the finish date of a project deletes all milestones and allocation segments that exist after the new project finish date.

Parameters

Name Key Required Type Description
Approved Budget
approvedBudget double
Days
days string

The request accepts either hours or days.

Hours
hours string

The request accepts either hours or days.

Name
name string

Missing values will be created automatically

If you import an unknown value, it will be automatically created for you in Meisterplan.

Cost Type
costType string

default: see Meisterplan documentation.

Finish
finish string

format: YYYY-MM-DD

Id
id string
Name
name string
Notes
notes string
Category
category True string
Position
position True string
Id
id string
Project Key
projectKey string

Must be unique and must not be empty.

Start
start string

format: YYYY-MM-DD

Value
value string

Missing values will be created automatically

If you import an unknown value, it will be automatically created for you in Meisterplan.

ProjectId
projectId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ProjectResponse
ProjectResponse

Update Resources

Perform an update on a resource specified by the given ID.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Parameters

Name Key Required Type Description
Id
id string

default: uses default calendar if path and id are null. If you specify the id to reference a calendar you must omit the path property.

Path
path string

default: uses default calendar if path and id are null. format: See endpoint description. If you specify the path to reference a calendar you must omit the id property.

Cost Per Hour
costPerHour double
Email Address
emailAddress string

Must be unique.

Start Date
startDate string

format: YYYY-MM-DD

Termination Date
terminationDate string

format: YYYY-MM-DD

External Id
externalId string
External Resource
externalResource boolean
First Name
firstName string
Last Name
lastName string
City
city string
Country
country string
Postal Code
postalCode string
Id
id string
Resource Key
resourceKey string

Must be unique. If empty, value will be generated.

Skills
Skills string
ResourceId
resourceId True string

Internal Meisterplan identifier

Returns

ResourceResponse
ResourceResponse

Update Roles

Perform an update on a role specified by the given ID. To do a partial update, only the updated fields need to be sent. To delete a field value, the field must be sent with an explicit null value. Fields with a default value will be reset to their default when set to null.

Paths

Paths delimited by / (e.g. in calendars and OBS unit paths) may define path segments which contain / by escaping with //. E.g. the path Europe/Berlin//Amsterdam will be interpreted as ['Europe', 'Berlin/Amsterdam']. An uneven amount of slashes will be interpreted as the following segment starting with one or more slashes.

Parameters

Name Key Required Type Description
Cost Per Hour
costPerHour double
Cost Type
costType string

default: see Meisterplan documentation.

External Id
externalId string

Must be unique.

Name
name string
RoleId
roleId True string

Internal Meisterplan identifier

Returns

RoleResponse
RoleResponse

Update the capacity segments of a role

Updates the capacity segments for the role specified by the given ID. To erase all capacity segments, send a segment without start or finish and 0 capacity

Parameters

Name Key Required Type Description
days
days double

The request accepts either FTE, hours or days.

finish
finish date
fte
fte double

The request accepts either FTE, hours or days.

hours
hours double

The request accepts either FTE, hours or days.

start
start date
RoleId
roleId True string

Internal Meisterplan identifier

ScenarioId
scenarioId True string

Internal Meisterplan identifier

Returns

ListResponseOfRoleCapacityResponse
ListResponseOfRoleCapacityResponse

Definitions

ActualTimeWorkedResponse

Name Path Type Description
ActualsEntityLinkResponse
bookedEntity ActualsEntityLinkResponse
Bookings
bookings array of ActualsBookingResponse

Booking date and hours of this actual time worked entry

ActualsBookingResponse

Name Path Type Description
Booking Date
bookingDate date

Booking date of this actual time worked entry

Hours
hours double

Actual time worked in hours

ActualsEntityLinkResponse

Name Path Type Description
Id
id string

The id of the entity to which this actual time worked entry is linked

Type
type string

The entity type for this actual time worked entry

AllProjectsPriorityResponse

Name Path Type Description
Rank
rank integer

Rank depends on the date range and portfolio filter.

Rank Category
rankCategory string

AllProjectsResponse

Name Path Type Description
Approved Budget
approvedBudget double
ApprovedTotalEffortResponse
approvedTotalEffort ApprovedTotalEffortResponse
BusinessGoalResponse
businessGoal BusinessGoalResponse
costType
costType string

default: see Meisterplan documentation.

customFields
customFields object
externalId
externalId string
finish
finish string

format: YYYY-MM-DD

id
id string
ProjectManagerResponse
manager ProjectManagerResponse
name
name string
notes
notes string
obsUnits
obsUnits object
AllProjectsPriorityResponse
priority AllProjectsPriorityResponse
ProgramLinkResponse
program ProgramLinkResponse
projectKey
projectKey string
start
start string

format: YYYY-MM-DD

StatusFieldResponse
status StatusFieldResponse

AllocatedEntityResponse

Name Path Type Description
Id
id string

The id of the entity to which this allocation is linked

Project Role
projectRole string

Will only be set if type equals RESOURCE

Type
type string

The entity type for this allocation

AllocationResponse

Name Path Type Description
AllocatedEntityResponse
allocatedEntity AllocatedEntityResponse
Id
id string

This allocation's ID

Segments
segments array of AllocationSegmentResponse

The allocation's time segments

AllocationSegmentResponse

Name Path Type Description
Finish
finish date

End date of this allocation

Hours
hours double

Allocation value in hours

Start
start date

Start date of this allocation

ApprovedTotalEffortResponse

Name Path Type Description
Hours
hours double

BusinessGoalDefinitionResponse

Name Path Type Description
Name
name string

BusinessGoalResponse

Name Path Type Description
Name
name string

CalendarDeviationResponse

Name Path Type Description
Finish
finish date
Relative Capacity
relativeCapacity double
Start
start date

CalendarExceptionResponse

Name Path Type Description
Date
date date
Description
description string
Source Calendar Id
sourceCalendarId string
Working Hours
workingHours double

CalendarResponse

Name Path Type Description
Id
id string
Name
name string
Parent Id
parentId string
Path
path string
WorkingHoursResponse
workingHours WorkingHoursResponse

Cursor

Name Path Type Description
Cursor
cursor string

EmploymentPeriodResponse

Name Path Type Description
Start Date
startDate string

format: YYYY-MM-DD

Termination Date
terminationDate string

format: YYYY-MM-DD

FinanceCategoryResponse

Name Path Type Description
Name
name string

FinancialsResponse

Name Path Type Description
Amount
amount double
FinanceCategoryResponse
category FinanceCategoryResponse
Description
description string
Id
id string
FinancialsTimingResponse
timing FinancialsTimingResponse
Type
type string

FinancialsTimingResponse

Name Path Type Description
Due Date
dueDate date
Milestone Id
milestoneId string

Only present when timing type equals Milestone

On
on string

ListResponseOfAllocationResponse

Name Path Type Description
Items
items array of AllocationResponse

ListResponseOfBusinessGoalDefinitionResponse

Name Path Type Description
Items
items array of BusinessGoalDefinitionResponse

ListResponseOfCalendarDeviationResponse

Name Path Type Description
Items
items array of CalendarDeviationResponse

ListResponseOfCalendarExceptionResponse

Name Path Type Description
Items
items array of CalendarExceptionResponse

ListResponseOfCalendarResponse

Name Path Type Description
Items
items array of CalendarResponse

ListResponseOfFinancialsResponse

Name Path Type Description
Items
items array of FinancialsResponse

ListResponseOfMilestoneResponse

Name Path Type Description
Items
items array of MilestoneResponse

ListResponseOfObsTypeResponse

Name Path Type Description
Items
items array of ObsTypeResponse

ListResponseOfObsUnitResponse

Name Path Type Description
Items
items array of ObsUnitResponse

ListResponseOfPortfolioResponse

Name Path Type Description
Items
items array of PortfolioResponse

ListResponseOfProgramResponse

Name Path Type Description
Items
items array of ProgramResponse

ListResponseOfRoleCapacityResponse

Name Path Type Description
Items
items array of RoleCapacityResponse

ListResponseOfRoleResponse

Name Path Type Description
Items
items array of RoleResponse

ListResponseOfRoleWithRoleCapacityResponse

Name Path Type Description
Items
items array of RoleWithRoleCapacityResponse

ListResponseOfScenarioResponse

Name Path Type Description
Items
items array of ScenarioResponse

MilestoneDependencyCreateResponse

Name Path Type Description
Id
id string

MilestoneDependencyResponse

Name Path Type Description
MilestoneReferenceResponse
from MilestoneReferenceResponse
Id
id string
MilestoneReferenceResponse
to MilestoneReferenceResponse

MilestoneReferenceResponse

Name Path Type Description
Milestone Id
milestoneId string
Project Id
projectId string

MilestoneResponse

Name Path Type Description
Date
date string

format: YYYY-MM-DD

Id
id string
Name
name string
ProjectPhaseResponse
projectPhase ProjectPhaseResponse

ObsTypeResponse

Name Path Type Description
Id
id string
Name
name string

ObsUnitResponse

Name Path Type Description
Display Name
displayName string

The display name is rendered the same way as it is in the Meisterplan application's user interface

Id
id string
Name
name string
Parent Id
parentId string
Path
path string

PaginatedResponseOfActualTimeWorkedResponse

Name Path Type Description
Pagination
_pagination Pagination
Items
items array of ActualTimeWorkedResponse

PaginatedResponseOfAllProjectsResponse

Name Path Type Description
Pagination
_pagination Pagination
Items
items array of AllProjectsResponse

PaginatedResponseOfMilestoneDependencyResponse

Name Path Type Description
Pagination
_pagination Pagination
Items
items array of MilestoneDependencyResponse

PaginatedResponseOfResourceResponse

Name Path Type Description
Pagination
_pagination Pagination
Items
items array of ResourceResponse

Pagination

Name Path Type Description
Cursor
after Cursor

PortfolioResponse

Name Path Type Description
Id
id string
Name
name string

PostalAddressResponse

Name Path Type Description
City
city string
Country
country string
Postal Code
postalCode string

PriorityResponse

Name Path Type Description
Rank Category
rankCategory string

ProgramLinkResponse

Name Path Type Description
Id
id string

ProgramResponse

Name Path Type Description
Id
id string
Name
name string

ProjectManagerResponse

Name Path Type Description
Id
id string

ProjectPhaseResponse

Name Path Type Description
Name
name string

ProjectResponse

Name Path Type Description
Approved Budget
approvedBudget double
ApprovedTotalEffortResponse
approvedTotalEffort ApprovedTotalEffortResponse
BusinessGoalResponse
businessGoal BusinessGoalResponse
costType
costType string

default: see Meisterplan documentation.

customFields
customFields object
externalId
externalId string
finish
finish string

format: YYYY-MM-DD

id
id string
ProjectManagerResponse
manager ProjectManagerResponse
name
name string
notes
notes string
obsUnits
obsUnits object
PriorityResponse
priority PriorityResponse
ProgramLinkResponse
program ProgramLinkResponse
projectKey
projectKey string
start
start string

format: YYYY-MM-DD

StatusFieldResponse
status StatusFieldResponse

ResourceCalendarResponse

Name Path Type Description
Id
id string
Path
path string

ResourceResponse

Name Path Type Description
ResourceCalendarResponse
calendar ResourceCalendarResponse
Cost Per Hour
costPerHour double
Email Address
emailAddress string
EmploymentPeriodResponse
employmentPeriod EmploymentPeriodResponse
External Id
externalId string
External Resource
externalResource boolean
First Name
firstName string
Id
id string
Last Name
lastName string
OBS Units
obsUnits object
PostalAddressResponse
postalAddress PostalAddressResponse
RoleResponse
primaryRole RoleResponse
Resource Key
resourceKey string
Skills
skills array of string

RoleCapacityResponse

Name Path Type Description
finish
finish date

End date of this role capacity segment. Optional.

fte
fte double

The role's capacity in FTE

start
start date

Start date of this role capacity segment. Optional.

RoleResponse

Name Path Type Description
Cost Per Hour
costPerHour double
Cost Type
costType string
External Id
externalId string
Id
id string
Name
name string
OBS Units
obsUnits object

RoleWithRoleCapacityResponse

Name Path Type Description
roleId
roleId string

The role's ID.

segments
segments array of RoleCapacityResponse

The role's capacity segments.

ScenarioResponse

Name Path Type Description
Id
id string
Name
name string

StatusFieldResponse

Name Path Type Description
Value
value string

If you have no permission to this field, the value is null.

WorkingHoursResponse

Name Path Type Description
Friday
friday double
Monday
monday double
Saturday
saturday double
Sunday
sunday double
Thursday
thursday double
Tuesday
tuesday double
Wednesday
wednesday double

object

This is the type 'object'.