Partilhar via


Meisterplan

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 itdesign GmbH
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.
  • Connect to Microsoft Teams: If a project is updated in Meisterplan, you will receive a notification in the configured Teams channel. This notification can be configured to include the link to the project in Meisterplan so you can quickly open the project for more details.
  • Connect to Your MS Office: If a new project is added in Meisterplan, specified colleagues will get notified by email. You can also configure the Flow to add the new project to your external back up source in MS Office.

Known issues and limitations

  • There are currently no known restrictions or limitations. General information about rate limiting, pagination, etc. can be found in the REST API documentation.

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. Some actions are only available with the Meisterplan Pro-Edition or Premium-Edition.

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 connection 100 60 seconds

Actions

Business Goals

Returns all business goals

Create a Milestone Dependency

Returns the id of the newly created milestone dependency

Create Absences

Use this request to add an absence for a certain time period. This time period can be defined using the start and finish attributes of the request.

Create Actual Financial Event

Returns the newly created actual financial event.

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 any given project. A request is limited to 5000 actual time worked values per project and resource/role.

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 or Update Task

Creates or update a task with the given fields

Create or Update Task Management Link

This endpoint lets you add a task management link to a project or update it's externalViewUrl. When this link is set, tasks can be added, updated and deleted using /tasks endpoint.Please note that task management data itself is independent from its scenario.

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.

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 Absence

Deletes an absence.

Delete Actual Financial Event

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

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.

Delete Task

Deletes a task in a given project.

Delete Task Management Link

Deletes a task management link of a project

Get a List of Absences

Returns a list of absences of the resource.

Get a List of Actual Financial Events

Returns a list of actual financial events of a project.

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 Allocation Comments

Returns a list of allocation comments.

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 Project Comments

Returns a list of project comments.

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 a List of Tasks

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

Get a List of Users

Returns a list of users. Allows filtering by userName or externalId.

Get a Project Comment by ID

Returns a project comment.

Get a User by ID

Returns a user.

Get Absences by ID

Returns the individual absence specified by the given ID.

Get Actual Financial Event by ID

Returns the individual actual financial event specified by the given ID.

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 Allocation Comment by ID

Returns an allocation comment.

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 Task by ID

Returns the individual task specified by the given ID.

Get Task Management Link

Returns a task management link of a project

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 Absences

This endpoint lets you replace all absences of a resource. The result will be the same as if all existing absences are deleted and the passed absences are created again. You can use the 'start' and 'end' query parameters to specify a time range for replacing existing absences. If you do not use these parameters, all absences will be replaced by the newly sent absences.

Replace Actual Financial Events

Replaces actual financial events of a given project within a scenario. A request is limited to 5000 actual financial events per project.

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 Absences

Use this request to update an absence.

Update Actual Financial Event

Returns the updated actual financial event.

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.

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.

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

Create a Milestone Dependency

Returns the id of the newly created milestone dependency

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

From Milestone ID
fromMilestoneId True string
To Milestone ID
toMilestoneId True string

Returns

Milestone Dependency Create
MilestoneDependencyCreateResponse

Create Absences

Use this request to add an absence for a certain time period. This time period can be defined using the start and finish attributes of the request.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Start
start True string

format: YYYY-MM-DD

Finish
finish True string

format: YYYY-MM-DD

Start Day Type
startDayType string

Default is FULL_DAY

Finish Day Type
finishDayType string

Default is FULL_DAY

Returns

Absence
AbsenceResponse

Create Actual Financial Event

Returns the newly created actual financial event.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Type
type True string
Amount
amount True double
Booking Date
bookingDate True date
Description
description string
Name
name string

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

Returns

Financial Actuals
FinancialActualsResponse

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
Monday
monday True double
Tuesday
tuesday True double
Wednesday
wednesday True double
Thursday
thursday True double
Friday
friday True double
Saturday
saturday True double
Sunday
sunday True double

Returns

Calendar
CalendarResponse

Create Financials

Returns the newly created financial event.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Type
type True string
Amount
amount True double
On
on True 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.

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.

Due Date
dueDate string

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

Description
description string
Name
name string

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

Returns

Financials
FinancialsResponse

Create Milestones

Returns the newly created milestone

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Name
name True string
Date
date True string

format: YYYY-MM-DD

Name
name string

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

Returns

Milestone
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

Obs Type
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
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Name
name True string
Parent ID
parentId string

Returns

Obs Unit
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 any given project. A request is limited to 5000 actual time worked values per project and resource/role.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

ID
id True string

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

Type
type string
Booking Date
bookingDate True date

Date of this booking

Hours
hours True double

Actual time worked in hours

Cost Type
costType string

default: see Meisterplan documentation.

Cost Per Hour
costPerHour double

Cost per hour for this booking

Mode
mode string

Returns

Actual Time Worked
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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

ID
id True 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.

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.

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.

Start
start True date
Finish
finish True date
Fte
fte double

The request accepts either FTE, hours or days.

Days
days double

The request accepts either FTE, hours or days.

Hours
hours double

The request accepts either FTE, hours or days.

Returns

Allocation
AllocationResponse

Create or Update Task

Creates or update a task with the given fields

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Payload
payload True dynamic

Task represented by a JSON document.

Returns

response
object

This endpoint lets you add a task management link to a project or update it's externalViewUrl. When this link is set, tasks can be added, updated and deleted using /tasks endpoint.Please note that task management data itself is independent from its scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Payload
payload True dynamic

Task Management Link represented by a JSON document.

Returns

The outputs of this operation are dynamic.

Create Programs

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Name
name True string

Returns

Program
ProgramResponse

Create Projects

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Payload
payload True dynamic

Project represented by a JSON document.

Returns

The outputs of this operation are dynamic.

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
Payload
payload True dynamic

Resource represented by a JSON document.

Returns

The outputs of this operation are dynamic.

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
Payload
payload True dynamic

Role represented by a JSON document.

Returns

The outputs of this operation are dynamic.

Delete Absence

Deletes an absence.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Absence Id
absenceId True string

Internal Meisterplan identifier

Delete Actual Financial Event

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Financial Actuals Id
actualFinancialEventId True string

Internal Meisterplan identifier

Delete Actual Time Worked

Deletes all actual time worked of a given project.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Delete Allocations

Deletes an allocation in a given project of a scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Allocation Id
allocationId True string

Internal Meisterplan identifier

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
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

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
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Obs Unit Id
obsUnitId True string

Internal Meisterplan identifier

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
Calendar Id
calendarId True string

Internal Meisterplan identifier

Delete Financials

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Financials Id
financialsId True string

Internal Meisterplan identifier

Delete Milestone Dependencies

Deletes a milestone dependency in a given scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Milestone Dependency Id
milestoneDependencyId True string

Internal Meisterplan identifier

Delete Milestones

Deletes a milestone in a given project of a scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Milestone Id
milestoneId True string

Internal Meisterplan identifier

Delete Programs

Deletes a program specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Program Id
programId True string

Internal Meisterplan identifier

Delete Projects

Deletes a project in a given scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

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
Resource Id
resourceId True string

Internal Meisterplan identifier

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
Role Id
roleId True string

Internal Meisterplan identifier

Delete Task

Deletes a task in a given project.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Task Id
taskId True string

Internal Meisterplan identifier

Deletes a task management link of a project

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Get a List of Absences

Returns a list of absences of the resource.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Start Date
startDate date

Start date for filtering time period

Finish Date
finishDate date

Inclusive finish date for filtering time period.

Returns

Get a List of Actual Financial Events

Returns a list of actual financial events of a project.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Page Size
pageSize integer

Page Size

Page After
pageAfter string

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

Filter
filter string

Stringified JSON object with a subset of properties of the expected object.

Returns

Get a List of Allocation Comments

Returns a list of allocation comments.

Parameters

Name Key Required Type Description
Page After
pageAfter string

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

Page Size
pageSize integer

Page Size

Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

Get a List of Allocations

Returns a list of allocations of a project

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

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
Calendar Id
calendarId True string

Internal Meisterplan identifier

Start Date
startDate date

Start Date

End Date
endDate date

End Date

Returns

Get a List of Calendars

Get a list of all calendars in your Meisterplan system.

Returns

Get a List of Financials

Returns a list of financials of a project

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

Get a List of Milestone Dependencies

Returns a list of milestones dependencies of a scenario

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Page Size
pageSize integer

Page Size

Page After
pageAfter string

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

Returns

Get a List of Milestones

Returns a list of milestones of a project

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

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

Get a List of Programs

Returns a list of programs in the given scenario

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Returns

Get a List of Project Comments

Returns a list of project comments.

Parameters

Name Key Required Type Description
Page After
pageAfter string

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

Page Size
pageSize integer

Page Size

Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Page Size
pageSize integer

Page Size

Page After
pageAfter string

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

Filter
filter string

Stringified JSON object with a subset of properties of the expected object.

Returns

The outputs of this operation are dynamic.

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
Page Size
pageSize integer

Page Size

Page After
pageAfter string

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

Filter
filter string

Stringified JSON object with a subset of properties of the expected object.

Returns

The outputs of this operation are dynamic.

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.

Returns

The outputs of this operation are dynamic.

Get a List of Scenarios

It returns a list of scenarios

Returns

Get a List of Tasks

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Page Size
pageSize integer

Page Size

Page After
pageAfter string

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

Key
key string

Selects all objects that matches the key exactly.

Returns

The outputs of this operation are dynamic.

Get a List of Users

Returns a list of users. Allows filtering by userName or externalId.

Parameters

Name Key Required Type Description
Page After
pageAfter string

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

Page Size
pageSize integer

Page Size

Filter
filter string

Stringified JSON object with a subset of properties of the expected object.

Returns

Get a Project Comment by ID

Returns a project comment.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Comment Id
commentId True string

Internal Meisterplan identifier

Returns

Project Comment
ProjectCommentResponse

Get a User by ID

Returns a user.

Parameters

Name Key Required Type Description
User Id
userId True string

Internal Meisterplan identifier

Returns

Get Absences by ID

Returns the individual absence specified by the given ID.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Absence Id
absenceId True string

Internal Meisterplan identifier

Returns

Absence
AbsenceResponse

Get Actual Financial Event by ID

Returns the individual actual financial event specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Financial Actuals Id
actualFinancialEventId True string

Internal Meisterplan identifier

Returns

Financial Actuals
FinancialActualsResponse

Get all OBS Types

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

Returns

Get all OBS Units

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

Parameters

Name Key Required Type Description
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Returns

Get Allocations by ID

Returns the individual allocation specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Allocation Id
allocationId True string

Internal Meisterplan identifier

Returns

Allocation
AllocationResponse

Get an Allocation Comment by ID

Returns an allocation comment.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Allocation Comment Id
allocationCommentId True string

Internal Meisterplan identifier

Returns

Allocation Comment
AllocationCommentResponse

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
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Returns

Obs Type
ObsTypeResponse

Get an OBS Unit

This endpoint returns a single OBS unit.

Parameters

Name Key Required Type Description
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Obs Unit Id
obsUnitId True string

Internal Meisterplan identifier

Returns

Obs Unit
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
Calendar Id
calendarId True string

Internal Meisterplan identifier

Returns

Calendar
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
Resource Id
resourceId True string

Internal Meisterplan identifier

Start
start date

Start date for filtering time period

Finish
finish date

Finish date for filtering time period

Returns

Get Financials by ID

Returns the individual financial event specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Financials Id
financialsId True string

Internal Meisterplan identifier

Returns

Financials
FinancialsResponse

Get Milestones by ID

Returns the individual milestone specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Milestone Id
milestoneId True string

Internal Meisterplan identifier

Returns

Milestone
MilestoneResponse

Get Projects by ID

Returns the individual project specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

The outputs of this operation are dynamic.

Get Resources by ID

Returns the individual resource specified by the given ID.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Returns

The outputs of this operation are dynamic.

Get Roles by ID

Returns the individual role specified by the given ID.

Parameters

Name Key Required Type Description
Role Id
roleId True string

Internal Meisterplan identifier

Returns

The outputs of this operation are dynamic.

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Returns

Scenario
ScenarioResponse

Get Task by ID

Returns the individual task specified by the given ID.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Task Id
taskId True string

Internal Meisterplan identifier

Returns

The outputs of this operation are dynamic.

Returns a task management link of a project

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Returns

The outputs of this operation are dynamic.

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Role Id
roleId True string

Internal Meisterplan identifier

Returns

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Returns

Replace Absences

This endpoint lets you replace all absences of a resource. The result will be the same as if all existing absences are deleted and the passed absences are created again. You can use the 'start' and 'end' query parameters to specify a time range for replacing existing absences. If you do not use these parameters, all absences will be replaced by the newly sent absences.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Start
start date

Start date of replacement period

End
end date

Inclusive end date of replacement period.

Start
start True string

format: YYYY-MM-DD

Finish
finish True string

format: YYYY-MM-DD

Start Day Type
startDayType string

Default is FULL_DAY

Finish Day Type
finishDayType string

Default is FULL_DAY

Replace Actual Financial Events

Replaces actual financial events of a given project within a scenario. A request is limited to 5000 actual financial events per project.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Type
type True string
Amount
amount True double
Booking Date
bookingDate True date
Description
description string
Name
name string

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

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

ID
id True 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.

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.

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.

Start
start True date
Finish
finish True date
Fte
fte double

The request accepts either FTE, hours or days.

Days
days double

The request accepts either FTE, hours or days.

Hours
hours double

The request accepts either FTE, hours or days.

Replace Financials

Replaces financial events of a given project within a scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Type
type True string
Amount
amount True double
On
on True 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.

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.

Due Date
dueDate string

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

Description
description string
Name
name string

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

Replace Milestones

Replaces milestones of a given project within a scenario.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Name
name True string
Date
date True string

format: YYYY-MM-DD

Name
name string

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

Set Default Calendar

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

Parameters

Name Key Required Type Description
ID
id True string

Update Absences

Use this request to update an absence.

Parameters

Name Key Required Type Description
Resource Id
resourceId True string

Internal Meisterplan identifier

Absence Id
absenceId True string

Internal Meisterplan identifier

Start
start string

format: YYYY-MM-DD

Finish
finish string

format: YYYY-MM-DD

Start Day Type
startDayType string
Finish Day Type
finishDayType string

Returns

Absence
AbsenceResponse

Update Actual Financial Event

Returns the updated actual financial event.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Financial Actuals Id
actualFinancialEventId True string

Internal Meisterplan identifier

Type
type string
Amount
amount double
Booking Date
bookingDate string

format: YYYY-MM-DD

Description
description string
Name
name string

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

Returns

Financial Actuals
FinancialActualsResponse

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Allocation Id
allocationId True string

Internal Meisterplan identifier

Start
start True date
Finish
finish True date
Fte
fte double

The request accepts either FTE, hours or days.

Days
days double

The request accepts either FTE, hours or days.

Hours
hours double

The request accepts either FTE, hours or days.

Returns

Allocation
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
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Obs Unit Id
obsUnitId True string

Internal Meisterplan identifier

Name
name string
Parent ID
parentId string

Returns

Obs Unit
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
Calendar Id
calendarId True string

Internal Meisterplan identifier

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

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
Calendar Id
calendarId True string

Internal Meisterplan identifier

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

Returns

Calendar
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
Resource Id
resourceId True string

Internal Meisterplan identifier

Start
start date
Finish
finish date
Start
start date
Finish
finish date
Relative Capacity
relativeCapacity True double

Returns

Update Financials

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Financials Id
financialsId True string

Internal Meisterplan identifier

Type
type string
Amount
amount double
On
on True 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.

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.

Due Date
dueDate string

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

Description
description string
Name
name string

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

Returns

Financials
FinancialsResponse

Update Milestones

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Milestone Id
milestoneId True string

Internal Meisterplan identifier

Name
name string
Date
date string

format: YYYY-MM-DD

Name
name string

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

Returns

Milestone
MilestoneResponse

Update OBS Types

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

Parameters

Name Key Required Type Description
Obs Type Id
obsTypeId True string

Internal Meisterplan identifier

Name
name True string

Returns

Obs Type
ObsTypeResponse

Update Priorities

This endpoint updates the priorities of projects and programs.

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

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

Update Programs

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Program Id
programId True string

Internal Meisterplan identifier

Name
name string

Returns

Program
ProgramResponse

Update Projects

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

Parameters

Name Key Required Type Description
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Project Id
projectId True string

Internal Meisterplan identifier

Payload
payload True dynamic

Project represented by a JSON document.

Returns

The outputs of this operation are dynamic.

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
Resource Id
resourceId True string

Internal Meisterplan identifier

Payload
payload True dynamic

Resource represented by a JSON document.

Returns

The outputs of this operation are dynamic.

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
Role Id
roleId True string

Internal Meisterplan identifier

Payload
payload True dynamic

Role represented by a JSON document.

Returns

The outputs of this operation are dynamic.

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
Scenario Id
scenarioId True string

Internal Meisterplan identifier

Role Id
roleId True string

Internal Meisterplan identifier

start
start date
finish
finish date
fte
fte double

The request accepts either FTE, hours or days.

days
days double

The request accepts either FTE, hours or days.

hours
hours double

The request accepts either FTE, hours or days.

Returns

Triggers

Create Webhook

Creates a webhook by the given fields and returns the newly created. 1000 webhooks are currently supported per system.

Create Webhook

Creates a webhook by the given fields and returns the newly created. 1000 webhooks are currently supported per system.

Parameters

Name Key Required Type Description
Event Types
eventTypes True array of string

At least one event type needs to be provided.

Scenario ID
scenarioId True string

The scenario you want to subscribe to.

Project ID
projectId string

The projectId is optional. It is only required if you want to subscribe to a specific project.

Returns

The outputs of this operation are dynamic.

Definitions

UserRefResponse

Name Path Type Description
User ID
id string
User Display Name
displayName string

ListResponseRoleCapacityResponse

Name Path Type Description
Items
items array of RoleCapacityResponse

RoleCapacityResponse

Name Path Type Description
start
start date

Start date of this role capacity segment. Optional.

finish
finish date

End date of this role capacity segment. Optional.

fte
fte double

The role's capacity in FTE

MilestoneResponse

Name Path Type Description
ID
id string
Name
name string
Date
date string

format: YYYY-MM-DD

Project Phase
projectPhase ProjectPhaseResponse

ProjectPhaseResponse

Name Path Type Description
Name
name string

FinanceCategoryResponse

Name Path Type Description
Name
name string

FinancialsResponse

Name Path Type Description
ID
id string
Type
type string
Amount
amount double
Financials Timing
timing FinancialsTimingResponse
Description
description string
Finance Category
category FinanceCategoryResponse

FinancialsTimingResponse

Name Path Type Description
On
on string
Milestone ID
milestoneId string

Only present when timing type equals Milestone

Due Date
dueDate date

FinancialActualsResponse

Name Path Type Description
ID
id string
Type
type string
Amount
amount double
Booking Date
bookingDate string

format: YYYY-MM-DD

Description
description string
Finance Category
category FinanceCategoryResponse

AllocatedEntityResponse

Name Path Type Description
ID
id string

The id of the entity to which this allocation is linked

Type
type string

The entity type for this allocation

Project Role
projectRole string

Will only be set if type equals RESOURCE

AllocationResponse

Name Path Type Description
ID
id string

This allocation's ID

Allocated Entity
allocatedEntity AllocatedEntityResponse
Segments
segments array of AllocationSegmentResponse

The allocation's time segments

AllocationSegmentResponse

The allocation's time segments

Name Path Type Description
Start
start date

Start date of this allocation

Finish
finish date

End date of this allocation

Hours
hours double

Allocation value in hours

ActualTimeWorkedResponse

Name Path Type Description
Actuals Entity Link
bookedEntity ActualsEntityLinkResponse
Bookings
bookings array of ActualsBookingResponse

Booking date and hours of this actual time worked entry

ActualsBookingResponse

Booking date and hours of this actual time worked entry

Name Path Type Description
Booking Date
bookingDate date

Booking date of this actual time worked entry

Hours
hours double

Actual time worked in hours

Cost Type
costType string
Cost Per Hour
costPerHour double

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

ProgramResponse

Name Path Type Description
ID
id string
Name
name string

MilestoneDependencyCreateResponse

Name Path Type Description
ID
id string

CalendarDeviationResponse

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

ListResponseCalendarDeviationResponse

Name Path Type Description
Items
items array of CalendarDeviationResponse

AbsenceResponse

Name Path Type Description
ID
id string

The id of the absence

Start Date
start date

Start date of this absence

Finish Date
finish date

Finish date of this absence

Start Absence Day Type
startDayType string
Finish Absence Day Type
finishDayType string

ObsTypeResponse

Name Path Type Description
ID
id string
Name
name string

ObsUnitResponse

Name Path Type Description
ID
id string
Name
name string
Path
path string
Display Name
displayName string

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

Parent ID
parentId string

CalendarResponse

Name Path Type Description
ID
id string
Name
name string
Parent ID
parentId string
Path
path string
Working Hours
workingHours WorkingHoursResponse

WorkingHoursResponse

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

Cursor

Name Path Type Description
Cursor
cursor string

Pagination

Name Path Type Description
Cursor
after Cursor

BasicUserGroupResponse

Name Path Type Description
Group ID
id string

ID of a user group.

Group Name
name string

Name of a user group.

LinkedResourceResponse

Name Path Type Description
ID
id string

ID of the linked resource.

Resource Key
resourceKey string

Resource key of the linked resource.

PaginatedResponseUserResponse

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

UserResponse

Name Path Type Description
ID
id string
Username
userName string
External ID
externalId string
Active
active boolean
emailAddress
emailAddress string
Last Name
lastName string
First Name
firstName string
Display Name
displayName string
Locale
locale string
groups
groups array of BasicUserGroupResponse
Last Login
lastLogin date-time
Email Verified
emailVerified boolean
Linked Resource
linkedResource LinkedResourceResponse
Password Never Expires
passwordNeverExpires boolean

ListResponseScenarioResponse

Name Path Type Description
Items
items array of ScenarioResponse

ScenarioResponse

Name Path Type Description
ID
id string
Name
name string

ListResponseRoleWithRoleCapacityResponse

Name Path Type Description
Items
items array of RoleWithRoleCapacityResponse

RoleWithRoleCapacityResponse

Name Path Type Description
roleId
roleId string

The role's ID.

segments
segments array of RoleCapacityResponse

The role's capacity segments.

ListResponseMilestoneResponse

Name Path Type Description
Items
items array of MilestoneResponse

ListResponseFinancialsResponse

Name Path Type Description
Items
items array of FinancialsResponse

ListResponseFinancialActualsResponse

Name Path Type Description
Items
items array of FinancialActualsResponse

PaginatedResponseProjectCommentResponse

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

ProjectCommentResponse

Name Path Type Description
ID
id string
Content
content string
User Ref
author UserRefResponse
Created Date
createdDate string
mentions
mentions array of UserRefResponse

ListResponseAllocationResponse

Name Path Type Description
Items
items array of AllocationResponse

AllocationCommentEntityResponse

Name Path Type Description
ID
id string

The id of the entity to which this allocation comment is linked

Type
type string

The type of the entity to which this allocation comment is linked

AllocationCommentResponse

Name Path Type Description
ID
id string
Content
content string
User Ref
author UserRefResponse
Created Date
createdDate string
mentions
mentions array of UserRefResponse
Allocated Entity
allocatedEntity AllocationCommentEntityResponse

PaginatedResponseAllocationCommentResponse

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

PaginatedResponseActualTimeWorkedResponse

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

ListResponseProgramResponse

Name Path Type Description
Items
items array of ProgramResponse

MilestoneDependencyResponse

Name Path Type Description
ID
id string
Milestone Reference
from MilestoneReferenceResponse
Milestone Reference
to MilestoneReferenceResponse

MilestoneReferenceResponse

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

PaginatedResponseMilestoneDependencyResponse

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

ListResponseAbsenceResponse

Name Path Type Description
Items
items array of AbsenceResponse

ListResponsePortfolioResponse

Name Path Type Description
Items
items array of PortfolioResponse

PortfolioResponse

Name Path Type Description
ID
id string
Name
name string

ListResponseObsTypeResponse

Name Path Type Description
Items
items array of ObsTypeResponse

ListResponseObsUnitResponse

Name Path Type Description
Items
items array of ObsUnitResponse

ListResponseCalendarResponse

Name Path Type Description
Items
items array of CalendarResponse

CalendarExceptionResponse

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

ListResponseCalendarExceptionResponse

Name Path Type Description
Items
items array of CalendarExceptionResponse

BusinessGoalDefinitionResponse

Name Path Type Description
Name
name string

ListResponseBusinessGoalDefinitionResponse

Name Path Type Description
Items
items array of BusinessGoalDefinitionResponse

object

This is the type 'object'.