Compartilhar via


Meisterplan

O Meisterplan é uma ferramenta de gerenciamento de recursos de nível de portfólio que ajuda os gerentes de portfólio e recursos a gerenciar pessoas entre equipes e iniciativas, independentemente de seu trabalho ser tradicional, ágil ou híbrido. Use-o para tomar decisões de portfólio confiantes e solucionar interativamente conflitos de recursos.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte ao Meisterplan
URL https://help.meisterplan.com/
Email support@meisterplan.com
Metadados do conector
Publicador itdesign GmbH
Site https://meisterplan.com
Política de privacidade https://meisterplan.com/privacy-and-data-protection/
Categorias Gestão de empresas; Business Intelligence

O Meisterplan é uma ferramenta de gerenciamento de recursos de nível de portfólio que ajuda os gerentes de portfólio e recursos a gerenciar pessoas entre equipes e iniciativas, independentemente de seu trabalho ser tradicional, ágil ou híbrido. Use-o para tomar decisões de portfólio confiantes e solucionar interativamente conflitos de recursos. Confira a disponibilidade e a capacidade dos recursos, obtenha visibilidade dos projetos, priorize e alinhe os portfólios de projetos às estratégias e gere simulações de cenário em tempo real com o Meisterplan. Usando o Conector Meisterplan, você pode integrar o Meisterplan a todas as ferramentas que suas equipes usam para que ninguém precise fazer a manutenção dupla nos dados do projeto. Se você precisar atualizar um projeto ou fazer uma solicitação de tempo limite aprovada, o Meisterplan e o Conector Meisterplan podem tornar o processo contínuo.

Pré-requisitos

Para usar o conector Meisterplan, você precisa de uma conta do Meisterplan . Para começar a usar o Meisterplan, solicite uma demonstração ou faça uma avaliação.

Como obter credenciais

Ao usar o Conector Meisterplan, aparece uma caixa de diálogo de logon que exige que você selecione a região em que o sistema Meisterplan está localizado (eua ou UE). Em seguida, insira suas credenciais para Meisterplan, ou seja, nome de usuário e senha e clique em Logon. Em seguida, clique em Autorizar para permitir que o conector acesse seu sistema Meisterplan.

Introdução ao conector

Casos de uso comuns são:

  • Atualizando informações do projeto: se você fizer uma alteração em um projeto em uma ferramenta de gerenciamento de projetos (por exemplo, Trello), como atualizar o status, o projeto correspondente no Meisterplan será atualizado automaticamente.
  • Sincronizando alocações: se você editar uma alocação em uma planilha online, como o MS Excel, a alocação correspondente no Meisterplan será atualizada automaticamente.
  • Mantendo suas ausências de recurso atualizadas: se você aprovar uma solicitação de tempo limite de um de seus funcionários em uma planilha online, como o Excel, a entrada de recurso correspondente no Meisterplan será atualizada automaticamente.
  • Adicionando novos projetos ao Meisterplan: se você adicionar um novo projeto em uma de suas ferramentas, um novo projeto será criado automaticamente no Meisterplan.
  • Adicionando novos recursos ao Meisterplan: se você atualizar sua planilha online com um novo funcionário, eles serão adicionados automaticamente ao Pool de Recursos no Meisterplan.
  • Atualizando regularmente os dados do funcionário: se você alterar o endereço de um recurso em sua planilha online, a entrada de recurso correspondente no Meisterplan será atualizada automaticamente.
  • Conecte-se ao Microsoft Teams: se um projeto for atualizado no Meisterplan, você receberá uma notificação no canal configurado do Teams. Essa notificação pode ser configurada para incluir o link para o projeto no Meisterplan para que você possa abrir rapidamente o projeto para obter mais detalhes.
  • Conecte-se ao Seu Ms Office: se um novo projeto for adicionado ao Meisterplan, os colegas especificados serão notificados por email. Você também pode configurar o Flow para adicionar o novo projeto à fonte de backup externa no MS Office.

Problemas e limitações conhecidos

  • No momento, não há restrições ou limitações conhecidas. Informações gerais sobre limitação de taxa, paginação etc. podem ser encontradas na documentação da API REST.

Erros e soluções comuns

O Conector Meisterplan usa a API REST do Meisterplan. Uma descrição incluindo códigos de status pode ser encontrada na documentação da API REST. Informações adicionais podem ser encontradas na Central de Ajuda.

perguntas frequentes

  • Quais direitos de usuário do Meisterplan eu preciso para poder usar o conector?

    • O usuário do Meisterplan precisa ter as APIs do Access Meisterplan e conectar aplicativos externos corretamente.
    • O usuário do Meisterplan precisa ter direitos de leitura e edição para os campos que você deseja ler ou atualizar usando o conector.
  • Posso usar o conector com a edição Meisterplan Basic?

    • Sim, o conector tem suporte em todas as edições do Meisterplan. Algumas ações só estão disponíveis com o Hubplan Pro-Edition ou Premium-Edition.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Região cadeia Região do sistema Meisterplan hospedado Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar alocações

Esse ponto de extremidade permite que você atualize as alocações existentes de um projeto. As alterações serão feitas somente para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Atualizar calendários

Execute uma atualização em um calendário especificado pela ID fornecida.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Atualizar desvios do calendário

Use essa solicitação para substituir todos os desvios de calendário de um recurso por um determinado período de tempo. Esse período de tempo pode ser definido usando os atributos de início e término raiz da solicitação. Especifique a nova lista de desvios de calendário com a propriedade de desvios. Observe que todos os desvios no período especificado serão substituídos pelos desvios listados na propriedade de desvios.

  • Se nulo for usado para o período inicial e o período de término, todos os desvios de calendário do recurso serão substituídos – se apenas a data de início do período for definida, todos os desvios a partir dessa hora serão substituídos – Se apenas a data de término do período for definida, todos os desvios até esse ponto serão substituídos – se nulo for usado para a data de início e/ou término de um desvio de calendário, o desvio é assumido para durar de ou até a data de início ou término raiz especificada acima.

Todos os desvios são mesclados em uma estrutura sequencial. Os casos de desvios sobrepostos serão resolvidos dando precedência a desvios que ocorrerão posteriormente na matriz.

Atualizar evento financeiro real

Retorna o evento financeiro real atualizado.

Atualizar exceções de calendário

Use essa solicitação para substituir todas as exceções de calendário por um determinado período de tempo. Esse período de tempo pode ser definido usando os atributos de início e término raiz da solicitação. Especifique a nova lista de exceções de calendário com a propriedade de exceções. Observe que todas as exceções no período especificado serão substituídas pelas exceções listadas na propriedade de exceções.

  • Se nulo for usado para o período inicial e o período de término, todas as exceções do calendário serão substituídas – se apenas a data de início do período for definida, todas as exceções a partir desta hora serão substituídas – se apenas a data de término do período for definida, todas as exceções até esse ponto serão substituídas – se uma exceção for removida e um calendário pai tiver uma exceção nessa data, este calendário herda a exceção do calendário pai.
Atualizar finanças

Atualiza um evento financeiro por ID em um determinado projeto de um cenário.

Atualizar funções

Execute uma atualização em uma função especificada pela ID fornecida. Para fazer uma atualização parcial, somente os campos atualizados precisam ser enviados. Para excluir um valor de campo, o campo deve ser enviado com um valor nulo explícito. Campos com um valor padrão serão redefinidos para o padrão quando definidos como nulos.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Atualizar marcos

Execute uma atualização em um marco especificado pela ID fornecida.

Atualizar o Teams

Execute uma atualização em uma equipe especificada pela ID fornecida.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Atualizar os segmentos de capacidade de uma função

Atualiza os segmentos de capacidade para a função especificada pela ID fornecida. Para apagar todos os segmentos de capacidade, envie um segmento sem iniciar ou concluir e 0 capacidade

Atualizar prioridades

Esse ponto de extremidade atualiza as prioridades de projetos e programas.

Atualizar programas

Execute uma atualização em um programa especificado pela ID fornecida.

Atualizar projetos

Execute uma atualização em um projeto especificado pela ID fornecida.

Atualizar recursos

Execute uma atualização em um recurso especificado pela ID fornecida.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Atualizar tipos de OBS

Executa uma atualização em um tipo OBS especificado pela ID fornecida.

Atualizar uma unidade OBS

Atualiza o nome de uma única unidade OBS ou move-o para um pai diferente.

Ausências de atualização

Use essa solicitação para atualizar uma ausência.

Criar Ausências

Use essa solicitação para adicionar uma ausência por um determinado período de tempo. Esse período de tempo pode ser definido usando os atributos de início e término da solicitação.

Criar calendários

Crie um calendário com os dados especificados. Retornará o calendário recém-criado.

Criar evento financeiro real

Retorna o evento financeiro real recém-criado.

Criar finanças

Retorna o evento financeiro recém-criado.

Criar funções

Retorna a função criada com êxito.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Criar marcos

Retorna o marco recém-criado

Criar o Teams

Cria uma equipe pelos campos especificados e retorna o recém-criado.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Criar ou atualizar alocações

Esse ponto de extremidade permite que você crie novas alocações e atualize as alocações existentes de um projeto. As alterações serão feitas somente para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Criar ou atualizar o link de gerenciamento de tarefas

Esse ponto de extremidade permite adicionar um link de gerenciamento de tarefas a um projeto ou atualizar o externalViewUrl

Criar ou atualizar o tempo real trabalhado

Esse ponto de extremidade permite que você crie um novo tempo real trabalhado e atualize o tempo real existente trabalhado de um projeto por uma entidade (recurso ou função). Não atualizaremos a hora real trabalhada para datas de reserva que não são especificadas na solicitação de determinado projeto e entidade. Com a propriedade de modo, você pode controlar se um valor de trabalho de tempo real existente é substituído pelo novo valor ou se seu valor é adicionado à reserva na solicitação. Observe que os próprios dados de tempo real trabalhados são independentes de seu cenário. Ele será o mesmo em todos os cenários para qualquer projeto específico. Uma solicitação é limitada a 5.000 valores de tempo real trabalhados por projeto e recurso/função.

Criar ou atualizar tarefa

Cria ou atualiza uma tarefa com os campos especificados.

Criar programas

Cria um programa com os campos especificados e retorna o programa recém-criado.

Criar projetos

Cria um projeto com os campos especificados e retorna o projeto recém-criado.

Criar recursos

Cria um recurso pelos campos especificados e retorna o recém-criado.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Criar tipo OBS

Cria um tipo de OBS com os dados fornecidos. Retornará o tipo OBS recém-criado.

Criar uma dependência de marco

Retorna a ID da dependência de marco recém-criada

Criar unidade OBS

Cria uma unidade OBS com os dados especificados. Retornará a unidade OBS recém-criada.

Definir calendário padrão

Define um calendário existente como o calendário padrão em seu sistema Meisterplan.

Excluir Alocações

Exclui uma alocação em um determinado projeto de um cenário.

Excluir Ausência

Exclui uma ausência.

Excluir calendários

Exclui um calendário em seu sistema Meisterplan. Observe que o calendário padrão ou um pai do calendário padrão não pode ser excluído.

Excluir dependências de marco

Exclui uma dependência de marco em um determinado cenário.

Excluir Equipes

Exclua a equipe especificada pela ID fornecida. Se a equipe com a ID fornecida não existir, a solicitação falhará.

Excluir evento financeiro real

Exclui um evento financeiro real em um determinado projeto de um cenário.

Excluir Finanças

Exclui um evento financeiro em um determinado projeto de um cenário.

Excluir funções

Exclua a função especificada pela ID fornecida. Se a função com a ID fornecida não existir, a solicitação falhará.

Excluir Link de Gerenciamento de Tarefas

Exclui um link de gerenciamento de tarefas de um projeto

Excluir Marcos

Exclui um marco em um determinado projeto de um cenário.

Excluir Programas

Exclui um programa especificado pela ID fornecida.

Excluir projetos

Exclui um projeto em um determinado cenário.

Excluir recursos

Exclua o recurso especificado pela ID fornecida. Se o recurso com a ID fornecida não existir, a solicitação falhará.

Excluir Tarefa

Exclui uma tarefa em um determinado projeto.

Excluir tempo real trabalhado por ID

Exclui um tempo real trabalhado em um determinado projeto de um cenário.

Excluir todo o tempo real trabalhado pela ID do projeto

Exclui todo o tempo real trabalhado de um determinado projeto.

Excluir um tipo de OBS por ID

Exclua o tipo de OBS especificado pela ID fornecida. Se o tipo OBS com a ID fornecida não existir, a solicitação falhará.

Excluir uma unidade do OBS por ID

Exclui a unidade OBS especificada pela ID fornecida. Se a unidade OBS com a ID fornecida não existir, a solicitação falhará.

Metas de negócios

Retorna todas as metas de negócios

Obter alocações por ID

Retorna a alocação individual especificada pela ID fornecida.

Obter ausências por ID

Retorna a ausência individual especificada pela ID fornecida.

Obter calendários por ID

Obtenha um calendário em seu sistema Meisterplan. Use a ID especial defaultCalendar para obter o calendário padrão.

Obter cenários por ID

Retorna o cenário individual especificado pela ID fornecida. DICA: você pode usar "planOfRecord" como a ID do cenário de plano de registro.

Obter desvios do calendário

Lê desvios para o horário de trabalho do calendário do recurso. Se nenhum valor de início e término for passado, todos os desvios do recurso solicitado serão retornados. Se apenas o início for passado, todos os desvios a partir dessa hora serão retornados. Se apenas o término for passado, todos os desvios até esse ponto serão retornados.

Obter Equipe por ID

Retorna a equipe individual especificada pela ID fornecida.

Obter evento financeiro real por ID

Retorna o evento financeiro real individual especificado pela ID fornecida.

Obter finanças por ID

Retorna o evento financeiro individual especificado pela ID fornecida.

Obter funções por ID

Retorna a função individual especificada pela ID fornecida.

Obter link de gerenciamento de tarefas

Retorna um link de gerenciamento de tarefas de um projeto

Obter marcos por ID

Retorna o marco individual especificado pela ID fornecida.

Obter os segmentos de capacidade de todas as funções

Retorna os segmentos de capacidade para todas as funções. Se nenhum segmento de capacidade existir para uma determinada função, suas capacidades de função estarão vazias.

Obter os segmentos de capacidade de uma função

Retorna os segmentos de capacidade para a função especificada pela ID fornecida. Retorna uma lista vazia se nenhum segmento de capacidade existir.

Obter Programa por ID

Retorna o programa individual especificado pela ID fornecida.

Obter projetos por ID

Retorna o projeto individual especificado pela ID fornecida.

Obter recursos por ID

Retorna o recurso individual especificado pela ID fornecida.

Obter Sprint por ID

Retorna o sprint individual especificado pela ID fornecida.

Obter tarefa por ID

Retorna a tarefa individual especificada pela ID fornecida.

Obter tempo real trabalhado por ID

Retorna o tempo real individual trabalhado especificado pela ID fornecida.

Obter todas as unidades do OBS

Esse ponto de extremidade retorna uma lista de todas as unidades OBS para o tipo OBS fornecido.

Obter todos os tipos de OBS

Esse ponto de extremidade é apenas para tipos OBS. Para obter unidades OBS, use /obsTypes/<obs-type-id>/obsUnits

Obter um comentário de alocação por ID

Retorna um comentário de alocação.

Obter um comentário do projeto por ID

Retorna um comentário do projeto.

Obter um tipo OBS por ID

Esse ponto de extremidade é apenas para tipos OBS. Para obter unidades OBS, use /obsTypes/<obs-type-id>/obsUnits

Obter um usuário por ID

Retorna um usuário.

Obter uma lista de alocações

Retorna uma lista de alocações de um projeto

Obter uma lista de ausências

Retorna uma lista de ausências do recurso.

Obter uma lista de calendários

Obtenha uma lista de todos os calendários em seu sistema Meisterplan.

Obter uma lista de cenários

Ele retorna uma lista de cenários

Obter uma lista de comentários de alocação

Retorna uma lista de comentários de alocação.

Obter uma lista de comentários do projeto

Retorna uma lista de comentários do projeto.

Obter uma lista de dependências de marco

Retorna uma lista de dependências de marcos de um cenário

Obter uma lista de eventos financeiros reais

Retorna uma lista de eventos financeiros reais de um projeto.

Obter uma lista de exceções de calendário

Obtenha uma lista de todas as exceções a este calendário em seu sistema Meisterplan.

Obter uma lista de finanças

Retorna uma lista de finanças de um projeto

Obter uma lista de funções

Retorna uma lista de todas as funções disponíveis. Se nenhuma função estiver disponível, uma lista vazia será retornada.

Obter uma lista de marcos

Retorna uma lista de marcos de um projeto

Obter uma lista de portfólios

Retorna uma lista de todos os portfólios disponíveis. Se você não tiver o direito de exibir qualquer portfólio, retornará uma lista de todos os portfólios disponíveis que você tem o direito de acessar por meio do token de API. Se você não tiver o direito de exibir qualquer portfólio, uma lista vazia será retornada.

Obter uma lista de programas

Retorna uma lista de programas no cenário fornecido

Obter uma lista de projetos

Esse ponto de extremidade é paginado. Ele retorna uma lista de projetos até o PAGESIZE especificado

Obter uma lista de recursos

Esse ponto de extremidade é paginado. Ele retorna uma lista de recursos até o PAGESIZE especificado

Obter uma lista de tarefas

Esse ponto de extremidade é paginado. Ele retorna uma lista de tarefas até o PAGESIZE especificado

Obter uma lista de tempo real trabalhado

Retorna uma lista de tempo real trabalhado para todos os projetos de um cenário específico. Observe que os próprios dados de tempo real trabalhados são independentes de seu cenário.

Obter uma lista de usuários

Retorna uma lista de usuários. Permite filtragem por userName ou externalId.

Obter uma lista do Teams

Esse ponto de extremidade é paginado. Ele retorna uma lista de equipes até o PAGESIZE especificado

Obter uma unidade OBS

Esse ponto de extremidade retorna uma única unidade OBS.

Substituir Alocações

Esse ponto de extremidade permite substituir todas as alocações de um projeto. O resultado será o mesmo que se todas as alocações existentes forem excluídas e as alocações passadas forem criadas novamente.

Substituir Ausências

Esse ponto de extremidade permite substituir todas as ausências de um recurso. O resultado será o mesmo que se todas as ausências existentes forem excluídas e as ausências aprovadas forem criadas novamente. Você pode usar os parâmetros de consulta 'start' e 'end' para especificar um intervalo de tempo para substituir as ausências existentes. Se você não usar esses parâmetros, todas as ausências serão substituídas pelas ausências enviadas recentemente.

Substituir eventos financeiros reais

Substitui eventos financeiros reais de um determinado projeto em um cenário. Uma solicitação é limitada a 5.000 eventos financeiros reais por projeto.

Substituir Finanças

Substitui eventos financeiros de um determinado projeto em um cenário.

Substituir Marcos

Substitui os marcos de um determinado projeto em um cenário.

Substituir Tarefas

Esse ponto de extremidade é usado para substituir todas as tarefas existentes de um projeto específico por uma nova lista de tarefas fornecidas na solicitação. Como funciona: você envia uma lista de tarefas para um projeto específico. O sistema sincronizará as tarefas do projeto com essa lista usando a chave de tarefa como identificador. Isso significa:

  • As tarefas atualmente no sistema, mas não em sua lista, serão excluídas. – As tarefas em sua lista que não existem no sistema serão criadas. – As tarefas que existem no sistema e em sua lista serão atualizadas, se houver alterações.

Atualizar alocações

Esse ponto de extremidade permite que você atualize as alocações existentes de um projeto. As alterações serão feitas somente para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID de alocação
allocationId True string

Identificador Meisterplan interno

Start
start True date
Término
finish True date
Fte
fte double

A solicitação aceita FTE, horas ou dias.

Dias
days double

A solicitação aceita FTE, horas ou dias.

Horas
hours double

A solicitação aceita FTE, horas ou dias.

Retornos

Alocação
AllocationResponse

Atualizar calendários

Execute uma atualização em um calendário especificado pela ID fornecida.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do calendário
calendarId True string

Identificador Meisterplan interno

Nome
name string
Segunda-feira
monday True double
Terça-feira
tuesday True double
Quarta-feira
wednesday True double
Quinta-feira
thursday True double
Sexta-feira
friday True double
Sábado
saturday True double
Domingo
sunday True double

Retornos

Calendário
CalendarResponse

Atualizar desvios do calendário

Use essa solicitação para substituir todos os desvios de calendário de um recurso por um determinado período de tempo. Esse período de tempo pode ser definido usando os atributos de início e término raiz da solicitação. Especifique a nova lista de desvios de calendário com a propriedade de desvios. Observe que todos os desvios no período especificado serão substituídos pelos desvios listados na propriedade de desvios.

  • Se nulo for usado para o período inicial e o período de término, todos os desvios de calendário do recurso serão substituídos – se apenas a data de início do período for definida, todos os desvios a partir dessa hora serão substituídos – Se apenas a data de término do período for definida, todos os desvios até esse ponto serão substituídos – se nulo for usado para a data de início e/ou término de um desvio de calendário, o desvio é assumido para durar de ou até a data de início ou término raiz especificada acima.

Todos os desvios são mesclados em uma estrutura sequencial. Os casos de desvios sobrepostos serão resolvidos dando precedência a desvios que ocorrerão posteriormente na matriz.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Start
start date
Término
finish date
Start
start date
Término
finish date
Capacidade relativa
relativeCapacity True double

Retornos

Atualizar evento financeiro real

Retorna o evento financeiro real atualizado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Financial Actuals Id
actualFinancialEventId True string

Identificador Meisterplan interno

Tipo
type string
Quantidade
amount double
Data da Reserva
bookingDate string

formato: YYYY-MM-DD

Description
description string
Nome
name string

A categoria financeira deve existir antes da criação. Ele não será criado implicitamente.

Retornos

Reais financeiros
FinancialActualsResponse

Atualizar exceções de calendário

Use essa solicitação para substituir todas as exceções de calendário por um determinado período de tempo. Esse período de tempo pode ser definido usando os atributos de início e término raiz da solicitação. Especifique a nova lista de exceções de calendário com a propriedade de exceções. Observe que todas as exceções no período especificado serão substituídas pelas exceções listadas na propriedade de exceções.

  • Se nulo for usado para o período inicial e o período de término, todas as exceções do calendário serão substituídas – se apenas a data de início do período for definida, todas as exceções a partir desta hora serão substituídas – se apenas a data de término do período for definida, todas as exceções até esse ponto serão substituídas – se uma exceção for removida e um calendário pai tiver uma exceção nessa data, este calendário herda a exceção do calendário pai.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do calendário
calendarId True string

Identificador Meisterplan interno

Start
start date
Término
finish date
Date
date True date
Horário de trabalho
workingHours True double
Description
description string

Atualizar finanças

Atualiza um evento financeiro por ID em um determinado projeto de um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID financeira
financialsId True string

Identificador Meisterplan interno

Tipo
type string
Quantidade
amount double
Por
on True string

Marco é válido apenas em combinação com um valor no campo milestoneId. A data só é válida em combinação com um valor no dueDate do campo.

ID do marco
milestoneId string

É válido apenas em combinação com on: Milestone. O marco deve existir no projeto. Ele não será criado implicitamente.

Data de vencimento
dueDate string

É válido apenas em combinação com em: Data (formato: YYYY-MM-DD).

Description
description string
Nome
name string

A categoria financeira deve existir antes da criação. Ele não será criado implicitamente.

Retornos

Finanças
FinancialsResponse

Atualizar funções

Execute uma atualização em uma função especificada pela ID fornecida. Para fazer uma atualização parcial, somente os campos atualizados precisam ser enviados. Para excluir um valor de campo, o campo deve ser enviado com um valor nulo explícito. Campos com um valor padrão serão redefinidos para o padrão quando definidos como nulos.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da função
roleId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Função representada por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Atualizar marcos

Execute uma atualização em um marco especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID do marco
milestoneId True string

Identificador Meisterplan interno

Nome
name string
Date
date string

formato: YYYY-MM-DD

Nome
name string

A fase do projeto deve existir antes da criação. Ele não será criado implicitamente.

Value
value string

Retornos

Atualizar o Teams

Execute uma atualização em uma equipe especificada pela ID fornecida.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da equipe
teamId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Equipe representada por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Atualizar os segmentos de capacidade de uma função

Atualiza os segmentos de capacidade para a função especificada pela ID fornecida. Para apagar todos os segmentos de capacidade, envie um segmento sem iniciar ou concluir e 0 capacidade

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID da função
roleId True string

Identificador Meisterplan interno

start
start date
acabar
finish date
Fte
fte double

A solicitação aceita FTE, horas ou dias.

Dias
days double

A solicitação aceita FTE, horas ou dias.

horas
hours double

A solicitação aceita FTE, horas ou dias.

Retornos

Atualizar prioridades

Esse ponto de extremidade atualiza as prioridades de projetos e programas.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID
id True string

O valor da ID pode ser um projeto ou um programa.

Cargo
position string

A posição pode ser FIRST ou LAST. FIRST é o padrão

ID
id True string

O valor da ID pode ser um projeto ou um programa.

Cargo
position string

A posição pode ser FIRST ou LAST. FIRST é o padrão

ID
id True string

O valor da ID pode ser um projeto ou um programa.

Cargo
position string

A posição pode ser FIRST ou LAST. FIRST é o padrão

Atualizar programas

Execute uma atualização em um programa especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do programa
programId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Programa representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Atualizar projetos

Execute uma atualização em um projeto especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Projeto representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Atualizar recursos

Execute uma atualização em um recurso especificado pela ID fornecida.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Recurso representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Atualizar tipos de OBS

Executa uma atualização em um tipo OBS especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

Nome
name True string

Retornos

Tipo de Obs
ObsTypeResponse

Atualizar uma unidade OBS

Atualiza o nome de uma única unidade OBS ou move-o para um pai diferente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

ID da unidade do Obs
obsUnitId True string

Identificador Meisterplan interno

Nome
name string
ID Principal
parentId string

Retornos

Unidade Obs
ObsUnitResponse

Ausências de atualização

Use essa solicitação para atualizar uma ausência.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

ID de ausência
absenceId True string

Identificador Meisterplan interno

Start
start string

formato: YYYY-MM-DD

Término
finish string

formato: YYYY-MM-DD

Tipo de Dia de Início
startDayType string
Tipo de Dia de Término
finishDayType string

Retornos

Ausência
AbsenceResponse

Criar Ausências

Use essa solicitação para adicionar uma ausência por um determinado período de tempo. Esse período de tempo pode ser definido usando os atributos de início e término da solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Start
start True string

formato: YYYY-MM-DD

Término
finish True string

formato: YYYY-MM-DD

Tipo de Dia de Início
startDayType string

O padrão é FULL_DAY

Tipo de Dia de Término
finishDayType string

O padrão é FULL_DAY

Retornos

Ausência
AbsenceResponse

Criar calendários

Crie um calendário com os dados especificados. Retornará o calendário recém-criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
name True string
ID Principal
parentId string
Segunda-feira
monday True double
Terça-feira
tuesday True double
Quarta-feira
wednesday True double
Quinta-feira
thursday True double
Sexta-feira
friday True double
Sábado
saturday True double
Domingo
sunday True double

Retornos

Calendário
CalendarResponse

Criar evento financeiro real

Retorna o evento financeiro real recém-criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Tipo
type True string
Quantidade
amount True double
Data da Reserva
bookingDate True date
Description
description string
Nome
name string

A categoria financeira deve existir antes da criação. Ele não será criado implicitamente.

Retornos

Reais financeiros
FinancialActualsResponse

Criar finanças

Retorna o evento financeiro recém-criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Tipo
type True string
Quantidade
amount True double
Por
on True string

Marco é válido apenas em combinação com um valor no campo milestoneId. A data só é válida em combinação com um valor no dueDate do campo.

ID do marco
milestoneId string

É válido apenas em combinação com on: Milestone. O marco deve existir no projeto. Ele não será criado implicitamente.

Data de vencimento
dueDate string

É válido apenas em combinação com em: Data (formato: YYYY-MM-DD).

Description
description string
Nome
name string

A categoria financeira deve existir antes da criação. Ele não será criado implicitamente.

Retornos

Finanças
FinancialsResponse

Criar funções

Retorna a função criada com êxito.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
Conteúdo
payload True dynamic

Função representada por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Criar marcos

Retorna o marco recém-criado

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Nome
name True string
Date
date True string

formato: YYYY-MM-DD

Nome
name string

A fase do projeto deve existir antes da criação. Ele não será criado implicitamente.

Value
value string

Retornos

Criar o Teams

Cria uma equipe pelos campos especificados e retorna o recém-criado.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
Conteúdo
payload True dynamic

Equipe representada por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Criar ou atualizar alocações

Esse ponto de extremidade permite que você crie novas alocações e atualize as alocações existentes de um projeto. As alterações serão feitas somente para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID
id True string

A ID da entidade à qual essa alocação está vinculada. Defina o tipo como RESOLVE_BY_KEY_OR_NAME para resolver automaticamente chaves de recurso ou nomes de função.

Tipo
type string

Controlar como o valor na ID do campo é interpretado. O RESOURCE resolve recursos por UUID. ROLE resolve funções por UUID. RESOLVE_BY_KEY_OR_NAME resolve os recursos por chave de recurso ou funções por nome de função.

Função de projeto
projectRole string

A ID da função à qual essa alocação está vinculada. Esse campo só é válido em combinação com os tipos RESOURCE ou RESOLVE_BY_KEY_OR_NAME. Se o tipo estiver definido como RESOLVE_BY_KEY_OR_NAME, projectRole será resolvido pelo nome.

Start
start True date
Término
finish True date
Fte
fte double

A solicitação aceita FTE, horas ou dias.

Dias
days double

A solicitação aceita FTE, horas ou dias.

Horas
hours double

A solicitação aceita FTE, horas ou dias.

Retornos

Alocação
AllocationResponse

Esse ponto de extremidade permite adicionar um link de gerenciamento de tarefas a um projeto ou atualizar o externalViewUrl

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Link de Gerenciamento de Tarefas representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Criar ou atualizar o tempo real trabalhado

Esse ponto de extremidade permite que você crie um novo tempo real trabalhado e atualize o tempo real existente trabalhado de um projeto por uma entidade (recurso ou função). Não atualizaremos a hora real trabalhada para datas de reserva que não são especificadas na solicitação de determinado projeto e entidade. Com a propriedade de modo, você pode controlar se um valor de trabalho de tempo real existente é substituído pelo novo valor ou se seu valor é adicionado à reserva na solicitação. Observe que os próprios dados de tempo real trabalhados são independentes de seu cenário. Ele será o mesmo em todos os cenários para qualquer projeto específico. Uma solicitação é limitada a 5.000 valores de tempo real trabalhados por projeto e recurso/função.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID
id True string

A ID da entidade à qual essa entrada de tempo real trabalhada está vinculada. Defina o tipo como RESOLVE_BY_KEY_OR_NAME para resolver automaticamente os nomes de função ou chaves de equipe e recursos.

Tipo
type string
ID da equipe
teamId string

A ID da equipe da entidade à qual essa entrada de tempo real trabalhada está vinculada

Data da Reserva
bookingDate True date

Data desta reserva

Horas
hours True double

Tempo real trabalhado em horas

Tipo de Custo
costType string

padrão: consulte a documentação do Meisterplan.

Custo por hora
costPerHour double

Custo por hora para esta reserva

Mode
mode string

Retornos

Tempo real trabalhado
ActualTimeWorkedResponse

Criar ou atualizar tarefa

Cria ou atualiza uma tarefa com os campos especificados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Tarefa representada por um documento JSON.

Criar programas

Cria um programa com os campos especificados e retorna o programa recém-criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Programa representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Criar projetos

Cria um projeto com os campos especificados e retorna o projeto recém-criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Conteúdo
payload True dynamic

Projeto representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Criar recursos

Cria um recurso pelos campos especificados e retorna o recém-criado.

Paths

Os caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm /por escape com //. Por exemplo, o caminho Europa/Berlim//Amsterdã será interpretado como ['Europa', 'Berlim/Amsterdã']. Uma quantidade desigual de barras será interpretada como o segmento a seguir, começando com uma ou mais barras.

Parâmetros

Nome Chave Obrigatório Tipo Description
Conteúdo
payload True dynamic

Recurso representado por um documento JSON.

Retornos

As saídas desta operação são dinâmicas.

Criar tipo OBS

Cria um tipo de OBS com os dados fornecidos. Retornará o tipo OBS recém-criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
name True string

Retornos

Tipo de Obs
ObsTypeResponse

Criar uma dependência de marco

Retorna a ID da dependência de marco recém-criada

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Da ID do Marco
fromMilestoneId True string
Para a ID do Marco
toMilestoneId True string

Retornos

Criação de dependência de marco
MilestoneDependencyCreateResponse

Criar unidade OBS

Cria uma unidade OBS com os dados especificados. Retornará a unidade OBS recém-criada.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

Nome
name True string
ID Principal
parentId string

Retornos

Unidade Obs
ObsUnitResponse

Definir calendário padrão

Define um calendário existente como o calendário padrão em seu sistema Meisterplan.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Excluir Alocações

Exclui uma alocação em um determinado projeto de um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID de alocação
allocationId True string

Identificador Meisterplan interno

Excluir Ausência

Exclui uma ausência.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

ID de ausência
absenceId True string

Identificador Meisterplan interno

Excluir calendários

Exclui um calendário em seu sistema Meisterplan. Observe que o calendário padrão ou um pai do calendário padrão não pode ser excluído.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do calendário
calendarId True string

Identificador Meisterplan interno

Excluir dependências de marco

Exclui uma dependência de marco em um determinado cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID de dependência de marco
milestoneDependencyId True string

Identificador Meisterplan interno

Excluir Equipes

Exclua a equipe especificada pela ID fornecida. Se a equipe com a ID fornecida não existir, a solicitação falhará.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da equipe
teamId True string

Identificador Meisterplan interno

Excluir evento financeiro real

Exclui um evento financeiro real em um determinado projeto de um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Financial Actuals Id
actualFinancialEventId True string

Identificador Meisterplan interno

Excluir Finanças

Exclui um evento financeiro em um determinado projeto de um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID financeira
financialsId True string

Identificador Meisterplan interno

Excluir funções

Exclua a função especificada pela ID fornecida. Se a função com a ID fornecida não existir, a solicitação falhará.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da função
roleId True string

Identificador Meisterplan interno

Exclui um link de gerenciamento de tarefas de um projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Excluir Marcos

Exclui um marco em um determinado projeto de um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID do marco
milestoneId True string

Identificador Meisterplan interno

Excluir Programas

Exclui um programa especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do programa
programId True string

Identificador Meisterplan interno

Excluir projetos

Exclui um projeto em um determinado cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Excluir recursos

Exclua o recurso especificado pela ID fornecida. Se o recurso com a ID fornecida não existir, a solicitação falhará.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Excluir Tarefa

Exclui uma tarefa em um determinado projeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID da tarefa
taskId True string

Identificador Meisterplan interno

Excluir tempo real trabalhado por ID

Exclui um tempo real trabalhado em um determinado projeto de um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID real
actualsId True string

Identificador Meisterplan interno

Excluir todo o tempo real trabalhado pela ID do projeto

Exclui todo o tempo real trabalhado de um determinado projeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Excluir um tipo de OBS por ID

Exclua o tipo de OBS especificado pela ID fornecida. Se o tipo OBS com a ID fornecida não existir, a solicitação falhará.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

Excluir uma unidade do OBS por ID

Exclui a unidade OBS especificada pela ID fornecida. Se a unidade OBS com a ID fornecida não existir, a solicitação falhará.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

ID da unidade do Obs
obsUnitId True string

Identificador Meisterplan interno

Metas de negócios

Retorna todas as metas de negócios

Retornos

Obter alocações por ID

Retorna a alocação individual especificada pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID de alocação
allocationId True string

Identificador Meisterplan interno

Retornos

Alocação
AllocationResponse

Obter ausências por ID

Retorna a ausência individual especificada pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

ID de ausência
absenceId True string

Identificador Meisterplan interno

Retornos

Ausência
AbsenceResponse

Obter calendários por ID

Obtenha um calendário em seu sistema Meisterplan. Use a ID especial defaultCalendar para obter o calendário padrão.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do calendário
calendarId True string

Identificador Meisterplan interno

Retornos

Calendário
CalendarResponse

Obter cenários por ID

Retorna o cenário individual especificado pela ID fornecida. DICA: você pode usar "planOfRecord" como a ID do cenário de plano de registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Retornos

Scenario
ScenarioResponse

Obter desvios do calendário

Lê desvios para o horário de trabalho do calendário do recurso. Se nenhum valor de início e término for passado, todos os desvios do recurso solicitado serão retornados. Se apenas o início for passado, todos os desvios a partir dessa hora serão retornados. Se apenas o término for passado, todos os desvios até esse ponto serão retornados.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Start
start date

Data de início para o período de tempo de filtragem

Término
finish date

Data de término do período de filtragem

Retornos

Obter Equipe por ID

Retorna a equipe individual especificada pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da equipe
teamId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Obter evento financeiro real por ID

Retorna o evento financeiro real individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Financial Actuals Id
actualFinancialEventId True string

Identificador Meisterplan interno

Retornos

Reais financeiros
FinancialActualsResponse

Obter finanças por ID

Retorna o evento financeiro individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID financeira
financialsId True string

Identificador Meisterplan interno

Retornos

Finanças
FinancialsResponse

Obter funções por ID

Retorna a função individual especificada pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da função
roleId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Retorna um link de gerenciamento de tarefas de um projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Obter marcos por ID

Retorna o marco individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID do marco
milestoneId True string

Identificador Meisterplan interno

Retornos

Obter os segmentos de capacidade de todas as funções

Retorna os segmentos de capacidade para todas as funções. Se nenhum segmento de capacidade existir para uma determinada função, suas capacidades de função estarão vazias.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Retornos

Obter os segmentos de capacidade de uma função

Retorna os segmentos de capacidade para a função especificada pela ID fornecida. Retorna uma lista vazia se nenhum segmento de capacidade existir.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID da função
roleId True string

Identificador Meisterplan interno

Retornos

Obter Programa por ID

Retorna o programa individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do programa
programId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Obter projetos por ID

Retorna o projeto individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Obter recursos por ID

Retorna o recurso individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Obter Sprint por ID

Retorna o sprint individual especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
Sprint Id
sprintId True string

Identificador Meisterplan interno

Retornos

Obter tarefa por ID

Retorna a tarefa individual especificada pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID da tarefa
taskId True string

Identificador Meisterplan interno

Retornos

As saídas desta operação são dinâmicas.

Obter tempo real trabalhado por ID

Retorna o tempo real individual trabalhado especificado pela ID fornecida.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID real
actualsId True string

Identificador Meisterplan interno

Retornos

Tempo real trabalhado por ID
ActualTimeWorkedByIdResponse

Obter todas as unidades do OBS

Esse ponto de extremidade retorna uma lista de todas as unidades OBS para o tipo OBS fornecido.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

Retornos

Obter todos os tipos de OBS

Esse ponto de extremidade é apenas para tipos OBS. Para obter unidades OBS, use /obsTypes/<obs-type-id>/obsUnits

Retornos

Obter um comentário de alocação por ID

Retorna um comentário de alocação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID de comentário de alocação
allocationCommentId True string

Identificador Meisterplan interno

Retornos

Comentário de alocação
AllocationCommentResponse

Obter um comentário do projeto por ID

Retorna um comentário do projeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID do comentário
commentId True string

Identificador Meisterplan interno

Retornos

Comentário do Projeto
ProjectCommentResponse

Obter um tipo OBS por ID

Esse ponto de extremidade é apenas para tipos OBS. Para obter unidades OBS, use /obsTypes/<obs-type-id>/obsUnits

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

Retornos

Tipo de Obs
ObsTypeResponse

Obter um usuário por ID

Retorna um usuário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Id do usuário
userId True string

Identificador Meisterplan interno

Retornos

Utilizador
UserResponse

Obter uma lista de alocações

Retorna uma lista de alocações de um projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de ausências

Retorna uma lista de ausências do recurso.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Data de Início
startDate date

Data de início para o período de tempo de filtragem

Data de término
finishDate date

Data de término inclusiva para o período de tempo de filtragem.

Retornos

Obter uma lista de calendários

Obtenha uma lista de todos os calendários em seu sistema Meisterplan.

Retornos

Obter uma lista de cenários

Ele retorna uma lista de cenários

Retornos

Obter uma lista de comentários de alocação

Retorna uma lista de comentários de alocação.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Tamanho da Página
pageSize integer

Tamanho da Página

ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de comentários do projeto

Retorna uma lista de comentários do projeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Tamanho da Página
pageSize integer

Tamanho da Página

ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de dependências de marco

Retorna uma lista de dependências de marcos de um cenário

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Retornos

Obter uma lista de eventos financeiros reais

Retorna uma lista de eventos financeiros reais de um projeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de exceções de calendário

Obtenha uma lista de todas as exceções a este calendário em seu sistema Meisterplan.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do calendário
calendarId True string

Identificador Meisterplan interno

Data de Início
startDate date

Data de Início

Data de Término
endDate date

Data de Término

Retornos

Obter uma lista de finanças

Retorna uma lista de finanças de um projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de funções

Retorna uma lista de todas as funções disponíveis. Se nenhuma função estiver disponível, uma lista vazia será retornada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado.

Retornos

As saídas desta operação são dinâmicas.

Obter uma lista de marcos

Retorna uma lista de marcos de um projeto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de portfólios

Retorna uma lista de todos os portfólios disponíveis. Se você não tiver o direito de exibir qualquer portfólio, retornará uma lista de todos os portfólios disponíveis que você tem o direito de acessar por meio do token de API. Se você não tiver o direito de exibir qualquer portfólio, uma lista vazia será retornada.

Retornos

Obter uma lista de programas

Retorna uma lista de programas no cenário fornecido

Parâmetros

Nome Chave Obrigatório Tipo Description
Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado. Seleciona todos os objetos que correspondem exatamente às propriedades especificadas. Os programas são pesquisáveis por programKey e nome. Observação: tome cuidado para codificar seu parâmetro na URL. { "programKey": cadeia de caracteres, "name": string }

ID do cenário
scenarioId True string

Identificador Meisterplan interno

Retornos

Obter uma lista de projetos

Esse ponto de extremidade é paginado. Ele retorna uma lista de projetos até o PAGESIZE especificado

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado.

Retornos

As saídas desta operação são dinâmicas.

Obter uma lista de recursos

Esse ponto de extremidade é paginado. Ele retorna uma lista de recursos até o PAGESIZE especificado

Parâmetros

Nome Chave Obrigatório Tipo Description
Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado.

Retornos

As saídas desta operação são dinâmicas.

Obter uma lista de tarefas

Esse ponto de extremidade é paginado. Ele retorna uma lista de tarefas até o PAGESIZE especificado

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Key
key string

Seleciona todos os objetos que correspondem exatamente à chave.

Retornos

As saídas desta operação são dinâmicas.

Obter uma lista de tempo real trabalhado

Retorna uma lista de tempo real trabalhado para todos os projetos de um cenário específico. Observe que os próprios dados de tempo real trabalhados são independentes de seu cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado.

Retornos

Obter uma lista de usuários

Retorna uma lista de usuários. Permite filtragem por userName ou externalId.

Parâmetros

Nome Chave Obrigatório Tipo Description
Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Tamanho da Página
pageSize integer

Tamanho da Página

Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado.

Retornos

Obter uma lista do Teams

Esse ponto de extremidade é paginado. Ele retorna uma lista de equipes até o PAGESIZE especificado

Parâmetros

Nome Chave Obrigatório Tipo Description
Tamanho da Página
pageSize integer

Tamanho da Página

Página Após
pageAfter string

O cursor após o qual recuperar resultados. O cursor pode ser obtido de uma solicitação anterior.

Filter
filter string

Objeto JSON com cadeia de caracteres com um subconjunto de propriedades do objeto esperado. Seleciona todos os objetos que correspondem exatamente às propriedades especificadas. Observação: tome cuidado para codificar seu parâmetro na URL. { "resourceKey": cadeia de caracteres, "name": string }

Retornos

As saídas desta operação são dinâmicas.

Obter uma unidade OBS

Esse ponto de extremidade retorna uma única unidade OBS.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do tipo Obs
obsTypeId True string

Identificador Meisterplan interno

ID da unidade do Obs
obsUnitId True string

Identificador Meisterplan interno

Retornos

Unidade Obs
ObsUnitResponse

Substituir Alocações

Esse ponto de extremidade permite substituir todas as alocações de um projeto. O resultado será o mesmo que se todas as alocações existentes forem excluídas e as alocações passadas forem criadas novamente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

ID
id True string

A ID da entidade à qual essa alocação está vinculada. Defina o tipo como RESOLVE_BY_KEY_OR_NAME para resolver automaticamente chaves de recurso ou nomes de função.

Tipo
type string

Controlar como o valor na ID do campo é interpretado. O RESOURCE resolve recursos por UUID. ROLE resolve funções por UUID. RESOLVE_BY_KEY_OR_NAME resolve os recursos por chave de recurso ou funções por nome de função.

Função de projeto
projectRole string

A ID da função à qual essa alocação está vinculada. Esse campo só é válido em combinação com os tipos RESOURCE ou RESOLVE_BY_KEY_OR_NAME. Se o tipo estiver definido como RESOLVE_BY_KEY_OR_NAME, projectRole será resolvido pelo nome.

Start
start True date
Término
finish True date
Fte
fte double

A solicitação aceita FTE, horas ou dias.

Dias
days double

A solicitação aceita FTE, horas ou dias.

Horas
hours double

A solicitação aceita FTE, horas ou dias.

Substituir Ausências

Esse ponto de extremidade permite substituir todas as ausências de um recurso. O resultado será o mesmo que se todas as ausências existentes forem excluídas e as ausências aprovadas forem criadas novamente. Você pode usar os parâmetros de consulta 'start' e 'end' para especificar um intervalo de tempo para substituir as ausências existentes. Se você não usar esses parâmetros, todas as ausências serão substituídas pelas ausências enviadas recentemente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do recurso
resourceId True string

Identificador Meisterplan interno

Start
start date

Data de início do período de substituição

participante
end date

Data de término inclusiva do período de substituição.

Start
start True string

formato: YYYY-MM-DD

Término
finish True string

formato: YYYY-MM-DD

Tipo de Dia de Início
startDayType string

O padrão é FULL_DAY

Tipo de Dia de Término
finishDayType string

O padrão é FULL_DAY

Substituir eventos financeiros reais

Substitui eventos financeiros reais de um determinado projeto em um cenário. Uma solicitação é limitada a 5.000 eventos financeiros reais por projeto.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Tipo
type True string
Quantidade
amount True double
Data da Reserva
bookingDate True date
Description
description string
Nome
name string

A categoria financeira deve existir antes da criação. Ele não será criado implicitamente.

Substituir Finanças

Substitui eventos financeiros de um determinado projeto em um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Tipo
type True string
Quantidade
amount True double
Por
on True string

Marco é válido apenas em combinação com um valor no campo milestoneId. A data só é válida em combinação com um valor no dueDate do campo.

ID do marco
milestoneId string

É válido apenas em combinação com on: Milestone. O marco deve existir no projeto. Ele não será criado implicitamente.

Data de vencimento
dueDate string

É válido apenas em combinação com em: Data (formato: YYYY-MM-DD).

Description
description string
Nome
name string

A categoria financeira deve existir antes da criação. Ele não será criado implicitamente.

Substituir Marcos

Substitui os marcos de um determinado projeto em um cenário.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Nome
name True string
Date
date True string

formato: YYYY-MM-DD

Nome
name string

A fase do projeto deve existir antes da criação. Ele não será criado implicitamente.

Value
value string

Substituir Tarefas

Esse ponto de extremidade é usado para substituir todas as tarefas existentes de um projeto específico por uma nova lista de tarefas fornecidas na solicitação. Como funciona: você envia uma lista de tarefas para um projeto específico. O sistema sincronizará as tarefas do projeto com essa lista usando a chave de tarefa como identificador. Isso significa:

  • As tarefas atualmente no sistema, mas não em sua lista, serão excluídas. – As tarefas em sua lista que não existem no sistema serão criadas. – As tarefas que existem no sistema e em sua lista serão atualizadas, se houver alterações.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cenário
scenarioId True string

Identificador Meisterplan interno

ID do projeto
projectId True string

Identificador Meisterplan interno

Solicitação de Substituição de Tarefa
tasksReplaceRequest True dynamic

Tarefa representada por um documento JSON.

Gatilhos

Criar Webhook

Cria um webhook pelos campos especificados e retorna o recém-criado. Atualmente, há suporte para 1.000 webhooks por sistema.

Criar Webhook

Cria um webhook pelos campos especificados e retorna o recém-criado. Atualmente, há suporte para 1.000 webhooks por sistema.

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipos de evento
eventTypes True array of string

Pelo menos um tipo de evento precisa ser fornecido.

ID do cenário
scenarioId True string

O cenário no qual você deseja assinar.

ID do projeto
projectId string

O projectId é opcional. Ele só será necessário se você quiser assinar um projeto específico.

Retornos

As saídas desta operação são dinâmicas.

Definições

UserRefResponse

Nome Caminho Tipo Description
ID do Usuário
id string
Nome de Exibição do Usuário
displayName string

ListResponseRoleCapacityResponse

Nome Caminho Tipo Description
Itens
items array of RoleCapacityResponse

RoleCapacityResponse

Nome Caminho Tipo Description
start
start date

Data de início desse segmento de capacidade de função. Optional.

acabar
finish date

Data de término desse segmento de capacidade de função. Optional.

Fte
fte double

A capacidade da função no FTE

MilestoneResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string
Date
date string

formato: YYYY-MM-DD

Fase do projeto
projectPhase ProjectPhaseResponse
Situação
status StatusResponse

ProjectPhaseResponse

Nome Caminho Tipo Description
Nome
name string

StatusResponse

Nome Caminho Tipo Description
Value
value string
Nome de Exibição
displayName string

FinanceCategoryResponse

Nome Caminho Tipo Description
Nome
name string

FinancialsResponse

Nome Caminho Tipo Description
ID
id string
Tipo
type string
Quantidade
amount double
Tempo financeiro
timing FinancialsTimingResponse
Description
description string
Categoria finanças
category FinanceCategoryResponse

FinancialsTimingResponse

Nome Caminho Tipo Description
Por
on string
ID do marco
milestoneId string

Presente somente quando o tipo de tempo for igual a Marco

Data de vencimento
dueDate date

FinancialActualsResponse

Nome Caminho Tipo Description
ID
id string
Tipo
type string
Quantidade
amount double
Data da Reserva
bookingDate string

formato: YYYY-MM-DD

Description
description string
Categoria finanças
category FinanceCategoryResponse

AllocatedEntityResponse

Nome Caminho Tipo Description
ID
id string

A ID da entidade à qual essa alocação está vinculada

Tipo
type string

O tipo de entidade para essa alocação

Função de projeto
projectRole string

Só será definido se o tipo for igual a RESOURCE

AllocationResponse

Nome Caminho Tipo Description
ID
id string

A ID dessa alocação

Entidade Alocada
allocatedEntity AllocatedEntityResponse
Segmentos
segments array of AllocationSegmentResponse

Segmentos de tempo da alocação

AllocationSegmentResponse

Segmentos de tempo da alocação

Nome Caminho Tipo Description
Start
start date

Data de início dessa alocação

Término
finish date

Data de término dessa alocação

Horas
hours double

Valor de alocação em horas

ActualTimeWorkedResponse

Nome Caminho Tipo Description
Link de entidade real
bookedEntity ActualsEntityLinkResponse
Reservas
bookings array of ActualsBookingResponse

Data e horas de reserva desta entrada trabalhada em tempo real

ActualsBookingResponse

Data e horas de reserva desta entrada trabalhada em tempo real

Nome Caminho Tipo Description
ID
id string

ID de reserva desta entrada trabalhada em tempo real

Data da Reserva
bookingDate date

Data de reserva desta entrada trabalhada em tempo real

Horas
hours double

Tempo real trabalhado em horas

Tipo de Custo
costType string
Custo por hora
costPerHour double

ActualsEntityLinkResponse

Nome Caminho Tipo Description
ID
id string

A ID da entidade à qual essa entrada de tempo real trabalhada está vinculada

Tipo
type string

O tipo de entidade para esta entrada de tempo real trabalhada

ID da equipe
teamId string

A ID da equipe da entidade à qual essa entrada de tempo real trabalhada está vinculada

MilestoneDependencyCreateResponse

Nome Caminho Tipo Description
ID
id string

CalendarDeviationResponse

Nome Caminho Tipo Description
Start
start date
Término
finish date
Capacidade relativa
relativeCapacity double

ListResponseCalendarDeviationResponse

Nome Caminho Tipo Description
Itens
items array of CalendarDeviationResponse

AbsenceResponse

Nome Caminho Tipo Description
ID
id string

A ID da ausência

Data de Início
start date

Data de início dessa ausência

Data de término
finish date

Data de término dessa ausência

Tipo de dia de ausência inicial
startDayType string
Tipo de dia de ausência de término
finishDayType string

ObsTypeResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string

ObsUnitResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string
Caminho
path string
Nome de Exibição
displayName string

O nome de exibição é renderizado da mesma maneira que é na interface do usuário do aplicativo Meisterplan

ID Principal
parentId string

CalendarResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string
ID Principal
parentId string
Caminho
path string
Horário de trabalho
workingHours WorkingHoursResponse

WorkingHoursResponse

Nome Caminho Tipo Description
Segunda-feira
monday double
Terça-feira
tuesday double
Quarta-feira
wednesday double
Quinta-feira
thursday double
Sexta-feira
friday double
Sábado
saturday double
Domingo
sunday double

Cursor

Nome Caminho Tipo Description
Cursor
cursor string

Paginação

Nome Caminho Tipo Description
Cursor
after Cursor

BasicUserGroupResponse

Nome Caminho Tipo Description
ID do grupo
id string

ID de um grupo de usuários.

Nome de Grupo
name string

Nome de um grupo de usuários.

LinkedResourceResponse

Nome Caminho Tipo Description
ID
id string

ID do recurso vinculado.

Chave de Recurso
resourceKey string

Chave de recurso do recurso vinculado.

PaginatedResponseUserResponse

Nome Caminho Tipo Description
Itens
items array of UserResponse
Paginação
_pagination Pagination

UserResponse

Nome Caminho Tipo Description
ID
id string
Nome de usuário
userName string
ID externa
externalId string
Active
active boolean
endereço de email
emailAddress string
Apelido
lastName string
Primeiro Nome
firstName string
Nome de Exibição
displayName string
Local
locale string
groups
groups array of BasicUserGroupResponse
Último Logon
lastLogin date-time
Email Verificado
emailVerified boolean
Recurso vinculado
linkedResource LinkedResourceResponse
A senha nunca expira
passwordNeverExpires boolean

SprintResponse

Nome Caminho Tipo Description
ID
id string
Tecla Sprint
key string
Nome
name string
Start
start date-time
participante
end date-time

ListResponseScenarioResponse

Nome Caminho Tipo Description
Itens
items array of ScenarioResponse

ScenarioResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string

ListResponseRoleWithRoleCapacityResponse

Nome Caminho Tipo Description
Itens
items array of RoleWithRoleCapacityResponse

RoleWithRoleCapacityResponse

Nome Caminho Tipo Description
roleId
roleId string

A ID da função.

segments
segments array of RoleCapacityResponse

Os segmentos de capacidade da função.

ListResponseMilestoneResponse

Nome Caminho Tipo Description
Itens
items array of MilestoneResponse

ListResponseFinancialsResponse

Nome Caminho Tipo Description
Itens
items array of FinancialsResponse

ListResponseFinancialActualsResponse

Nome Caminho Tipo Description
Itens
items array of FinancialActualsResponse

PaginatedResponseProjectCommentResponse

Nome Caminho Tipo Description
Itens
items array of ProjectCommentResponse
Paginação
_pagination Pagination

ProjectCommentResponse

Nome Caminho Tipo Description
ID
id string
Content
content string
Ref do Usuário
author UserRefResponse
Data de criação
createdDate string
menções
mentions array of UserRefResponse

ListResponseAllocationResponse

Nome Caminho Tipo Description
Itens
items array of AllocationResponse

AllocationCommentEntityResponse

Nome Caminho Tipo Description
ID
id string

A ID da entidade à qual esse comentário de alocação está vinculado

Tipo
type string

O tipo da entidade à qual esse comentário de alocação está vinculado

AllocationCommentResponse

Nome Caminho Tipo Description
ID
id string
Content
content string
Ref do Usuário
author UserRefResponse
Data de criação
createdDate string
menções
mentions array of UserRefResponse
Entidade Alocada
allocatedEntity AllocationCommentEntityResponse

PaginatedResponseAllocationCommentResponse

Nome Caminho Tipo Description
Itens
items array of AllocationCommentResponse
Paginação
_pagination Pagination

PaginatedResponseActualTimeWorkedResponse

Nome Caminho Tipo Description
Itens
items array of ActualTimeWorkedResponse
Paginação
_pagination Pagination

ActualTimeWorkedByIdResponse

Nome Caminho Tipo Description
Link de entidade real
bookedEntity ActualsEntityLinkResponse
ID
id string

ID de reserva desta entrada trabalhada em tempo real

Data da Reserva
bookingDate date

Data de reserva desta entrada trabalhada em tempo real

Horas
hours double

Tempo real trabalhado em horas

Tipo de Custo
costType string
Custo por hora
costPerHour double

PaginatedResponseProgramGetAllResponse

Nome Caminho Tipo Description
Itens
items array of ProgramGetAllResponse
Paginação
_pagination Pagination

ProgramGetAllResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string
Chave do Programa
programKey string

Deve ser exclusivo. Se estiver vazio, o valor será gerado.

MilestoneDependencyResponse

Nome Caminho Tipo Description
ID
id string
Referência de marco
from MilestoneReferenceResponse
Referência de marco
to MilestoneReferenceResponse

MilestoneReferenceResponse

Nome Caminho Tipo Description
ID do projeto
projectId string
ID do marco
milestoneId string

PaginatedResponseMilestoneDependencyResponse

Nome Caminho Tipo Description
Itens
items array of MilestoneDependencyResponse
Paginação
_pagination Pagination

ListResponseAbsenceResponse

Nome Caminho Tipo Description
Itens
items array of AbsenceResponse

ListResponsePortfolioResponse

Nome Caminho Tipo Description
Itens
items array of PortfolioResponse

PortfolioResponse

Nome Caminho Tipo Description
ID
id string
Nome
name string

ListResponseObsTypeResponse

Nome Caminho Tipo Description
Itens
items array of ObsTypeResponse

ListResponseObsUnitResponse

Nome Caminho Tipo Description
Itens
items array of ObsUnitResponse

ListResponseCalendarResponse

Nome Caminho Tipo Description
Itens
items array of CalendarResponse

CalendarExceptionResponse

Nome Caminho Tipo Description
Date
date date
Horário de trabalho
workingHours double
Description
description string
ID do calendário de origem
sourceCalendarId string

ListResponseCalendarExceptionResponse

Nome Caminho Tipo Description
Itens
items array of CalendarExceptionResponse

BusinessGoalDefinitionResponse

Nome Caminho Tipo Description
Nome
name string
subGoals
subGoals array of SubGoalDefinitionResponse

ListResponseBusinessGoalDefinitionResponse

Nome Caminho Tipo Description
Itens
items array of BusinessGoalDefinitionResponse

SubGoalDefinitionResponse

Nome Caminho Tipo Description
Nome
name string
Nome de Exibição
displayName string