Partilhar via


Meisterplan

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

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Meisterplan
URL https://help.meisterplan.com/
Email support@meisterplan.com
Metadados do conector
Editora itdesign GmbH [en]
Sítio Web https://meisterplan.com
Política de privacidade https://meisterplan.com/privacy-and-data-protection/
Categorias Gestão Empresarial; Inteligência de Negócios

O Meisterplan é uma ferramenta de gerenciamento de recursos em nível de portfólio que ajuda os gerentes de portfólio e recursos a gerenciar pessoas em equipes e iniciativas, independentemente de seu trabalho ser tradicional, ágil ou híbrido. Use-o para tomar decisões de portfólio confiáveis e interativamente aflorar e resolver conflitos de recursos. Veja 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ários em tempo real com o Meisterplan. Usando o Meisterplan Connector, você pode integrar o Meisterplan com todas as ferramentas que suas equipes usam para que ninguém precise fazer manutenção dupla nos dados do projeto. Se você precisa atualizar um projeto ou fazer uma solicitação de tempo de folga aprovada, o Meisterplan e o Meisterplan Connector podem tornar o processo perfeito.

Pré-requisitos

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

Como obter credenciais

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

Introdução ao conector

Os 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.
  • Sincronização de 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.
  • Manter suas ausências de recursos atualizadas: se você aprovar uma solicitação de folga de um de seus funcionários em uma planilha on-line 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.
  • Atualização regular dos dados dos funcionários: Se você alterar o endereço de um recurso em sua planilha on-line, a entrada de recurso correspondente no Meisterplan será atualizada automaticamente.
  • Conectar-se ao Microsoft Teams: Se um projeto for atualizado no Meisterplan, você receberá uma notificação no canal do Teams configurado. 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 no Meisterplan, os colegas especificados serão notificados por e-mail. Você também pode configurar o Flow para adicionar o novo projeto à sua fonte de backup externa no MS Office.

Problemas conhecidos e limitações

  • Atualmente, não existem 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 Meisterplan Connector 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.

FAQ

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

    • Seu usuário do Meisterplan precisa ter as APIs do Access Meisterplan e Connect External Applications corretas.
    • Seu 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 é suportado por todas as edições do Meisterplan. Algumas ações só estão disponíveis com o Meisterplan Pro-Edition ou Premium-Edition.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) Região do seu sistema Meisterplan hospedado Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar alocações

Este ponto de extremidade permite atualizar as alocações existentes de um projeto. As alterações só serão feitas 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 pelo ID fornecido.

Paths

Caminhos delimitados por / (por exemplo, em calendários e caminhos de unidade OBS) podem definir segmentos de caminho que contêm / escapando com //. Por exemplo, o caminho Europa/Berlim//Amesterdão será interpretado como [«Europa», «Berlim/Amesterdão»]. Uma quantidade desigual de barras será interpretada como o seguinte segmento 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 raiz de início e término da solicitação. Especifique a nova lista de desvios de calendário com a propriedade deviations. Observe que todos os desvios no período especificado serão substituídos pelos desvios listados na propriedade deviations.

  • Se null for usado para o período inicial e o período final, 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 desta hora serão substituídos - Se apenas a data final do período for definida, todos os desvios até esse ponto serão substituídos - Se null for usado para a data de início e/ou fim de um desvio de calendário, Presume-se que o desvio dure a partir de ou até a data de início ou término da raiz especificada acima.

Todos os desvios são achatados, numa estrutura sequencial. Os casos de desvios sobrepostos serão resolvidos dando precedência aos desvios que ocorrem posteriormente na matriz.

Atualizar Equipas

Execute uma atualização em uma equipe especificada pelo ID fornecido.

Paths

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

Atualizar evento financeiro real

Devolve o evento financeiro real atualizado.

Atualizar exceções de calendário

Use esta 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 raiz de início e término da solicitação. Especifique a nova lista de exceções de calendário com a propriedade exceptions. Observe que todas as exceções no período especificado serão substituídas pelas exceções listadas na propriedade exceptions.

  • Se null for usado para o período inicial e o período final, 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 final 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 marcos

Execute uma atualização em uma etapa especificada pelo ID fornecido.

Atualizar os segmentos de capacidade de uma função

Atualiza os segmentos de capacidade para a função especificada pelo ID fornecido. Para apagar todos os segmentos de capacidade, envie um segmento sem início ou fim e capacidade 0

Atualizar prioridades

Este ponto final atualiza as prioridades de projetos e programas.

Atualizar programas

Execute uma atualização em um programa especificado pelo ID fornecido.

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

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

Atualizar tipos de OBS

Executa uma atualização em um tipo de OBS especificado pelo ID fornecido.

Atualizar uma unidade OBS

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

Ausências de atualização

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

Criar ausências

Use esta 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 fornecidos. Retornará o calendário recém-criado.

Criar Equipas

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

Paths

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

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 no sucesso.

Paths

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

Criar marcos

Devolve o marco recém-criado

Criar ou atualizar alocações

Este ponto de extremidade permite criar novas alocações e atualizar alocações existentes de um projeto. As alterações só serão feitas para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Criar ou atualizar 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

Este ponto de extremidade permite criar um novo tempo real trabalhado e atualizar o tempo real trabalhado existente de um projeto por uma entidade (recurso ou função). Não atualizaremos o tempo real trabalhado para datas de reserva que não estejam especificadas na solicitação para um determinado projeto e entidade. Com a propriedade mode, você pode controlar se um valor de tempo real trabalhado existente é substituído pelo novo valor ou se seu valor é adicionado à reserva na solicitação. Observe que os dados de tempo real trabalhado em si são independentes de seu cenário. Será o mesmo em todos os cenários para qualquer projeto. Uma solicitação é limitada a 5000 valores de tempo real trabalhado por projeto e recurso/função.

Criar ou atualizar tarefa

Cria ou atualiza uma tarefa com os campos fornecidos.

Criar Programas

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

Criar projetos

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

Criar recursos

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

Paths

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

Criar tipo de OBS

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

Criar uma dependência de etapa

Retorna a id da dependência de etapa recém-criada

Criar Unidade OBS

Cria uma unidade OBS com os dados fornecidos. 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 no 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 etapas

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

Excluir equipes

Exclua a equipe especificada pelo ID fornecido. 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 uma etapa em um determinado projeto de um cenário.

Excluir programas

Exclui um programa especificado pelo ID fornecido.

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 pelo ID fornecido. Se o tipo OBS com o ID fornecido não existir, a solicitação falhará.

Excluir uma unidade OBS por ID

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

Funções de atualização

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

Paths

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

Objetivos de Negócio

Devolve todos os objetivos de negócio

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

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

Obtenha todas as unidades OBS

Este ponto de extremidade retorna uma lista de todas as unidades OBS para um determinado tipo de OBS.

Obtenha todos os tipos de OBS

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

Obtenha uma lista de finanças

Devolve uma lista de finanças de um projeto

Obtenha uma unidade OBS

Este ponto de extremidade retorna uma única unidade OBS.

Obter alocações por ID

Devolve a alocação individual especificada pelo ID fornecido.

Obter ausências por ID

Devolve a ausência individual especificada pelo ID fornecido.

Obter calendários por ID

Obtenha um calendário no 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 o ID para o cenário de plano de registro.

Obter desvios do calendário

Lê desvios para as horas 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 deste momento serão retornados. Se apenas o término for passado, todos os desvios até esse ponto serão retornados.

Obter Equipa por ID

Devolve a equipa individual especificada pelo ID fornecido.

Obter evento financeiro real por ID

Devolve o evento financeiro real individual especificado pelo ID fornecido.

Obter Finanças por ID

Devolve o evento financeiro individual especificado pelo ID fornecido.

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

Devolve o marco individual especificado pelo ID fornecido.

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 não existirem segmentos de capacidade.

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

Devolve o sprint individual especificado pelo ID fornecido.

Obter Tarefa por ID

Retorna a tarefa individual especificada pela ID fornecida.

Obter tempo real trabalhado por ID

Devolve o tempo real de trabalho individual especificado pelo ID fornecido.

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 OBS Tipo por ID

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

Obter um utilizador por ID

Retorna um usuário.

Obter uma lista de alocações

Devolve 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 no 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 etapas

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

Obter uma lista de equipas

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

Obter uma lista de eventos financeiros reais

Devolve 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 no seu sistema Meisterplan.

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

Devolve uma lista de marcos de um projeto

Obter uma lista de portfólios

Devolve uma lista de todas as carteiras disponíveis. Se você não tem o direito de visualizar nenhum portfólio, retorna uma lista de todos os portfólios disponíveis que você tem o direito de acessar por meio do seu token de API. Se você não tiver o direito de visualizar qualquer portfólio, uma lista vazia será devolvida.

Obter uma lista de programas

Retorna uma lista de programas no cenário determinado

Obter uma lista de projetos

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

Obter uma lista de recursos

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

Obter uma lista de tarefas

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

Obter uma lista de usuários

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

Obter uma lista do tempo real trabalhado

Retorna uma lista do tempo real trabalhado para todos os projetos de um cenário específico. Observe que os dados de tempo real trabalhado em si são independentes de seu cenário.

Substitua as finanças

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

Substituir alocações

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

Substituir ausências

Este ponto de extremidade permite substituir todas as ausências de um recurso. O resultado será o mesmo como se todas as ausências existentes fossem eliminadas e as ausências passadas fossem criadas novamente. Você pode usar os parâmetros de consulta 'start' e 'end' para especificar um intervalo de tempo para substituir ausências existentes. Se você não usar esses parâmetros, todas as ausências serão substituídas pelas ausências recém-enviadas.

Substituir eventos financeiros reais

Substitui eventos financeiros reais de um determinado projeto dentro de um cenário. Um pedido está limitado a 5000 eventos financeiros reais por projeto.

Substituir marcos

Substitui marcos de um determinado projeto dentro de um cenário.

Substituir tarefas

Este 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 irá sincronizar as tarefas do projeto com esta lista usando a chave de tarefa como identificador. Isto significa:

  • As tarefas atualmente no sistema, mas não na sua lista, serão excluídas. - Serão criadas tarefas na sua lista que não existam no sistema. - As tarefas que existem tanto no sistema como na sua lista serão atualizadas, caso haja alterações.

Atualizar alocações

Este ponto de extremidade permite atualizar as alocações existentes de um projeto. As alterações só serão feitas para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID de alocação
allocationId True string

Identificador interno do Meisterplan

Start
start True date
Conclusão
finish True date
FTE
fte double

O pedido aceita ETC, horas ou dias.

Dias
days double

O pedido aceita ETC, horas ou dias.

Horário
hours double

O pedido aceita ETC, horas ou dias.

Devoluções

Repartição
AllocationResponse

Atualizar calendários

Execute uma atualização em um calendário especificado pelo ID fornecido.

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
ID do calendário
calendarId True string

Identificador interno do Meisterplan

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

Devoluções

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 raiz de início e término da solicitação. Especifique a nova lista de desvios de calendário com a propriedade deviations. Observe que todos os desvios no período especificado serão substituídos pelos desvios listados na propriedade deviations.

  • Se null for usado para o período inicial e o período final, 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 desta hora serão substituídos - Se apenas a data final do período for definida, todos os desvios até esse ponto serão substituídos - Se null for usado para a data de início e/ou fim de um desvio de calendário, Presume-se que o desvio dure a partir de ou até a data de início ou término da raiz especificada acima.

Todos os desvios são achatados, numa estrutura sequencial. Os casos de desvios sobrepostos serão resolvidos dando precedência aos desvios que ocorrem posteriormente na matriz.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Start
start date
Conclusão
finish date
Start
start date
Conclusão
finish date
Capacidade Relativa
relativeCapacity True double

Devoluções

Atualizar Equipas

Execute uma atualização em uma equipe especificada pelo ID fornecido.

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
ID da Equipa
teamId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Equipe representada por um documento JSON.

Devoluções

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

Atualizar evento financeiro real

Devolve o evento financeiro real atualizado.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Id do Real Financeiro
actualFinancialEventId True string

Identificador interno do Meisterplan

Tipo
type string
Montante
amount double
Data da Reserva
bookingDate string

formato: AAAA-MM-DD

Description
description string
Nome
name string

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

Devoluções

Realidade Financeira
FinancialActualsResponse

Atualizar exceções de calendário

Use esta 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 raiz de início e término da solicitação. Especifique a nova lista de exceções de calendário com a propriedade exceptions. Observe que todas as exceções no período especificado serão substituídas pelas exceções listadas na propriedade exceptions.

  • Se null for usado para o período inicial e o período final, 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 final 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

Name Chave Necessário Tipo Description
ID do calendário
calendarId True string

Identificador interno do Meisterplan

Start
start date
Conclusão
finish date
Date
date True date
Horário de Funcionamento
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

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Finanças Id
financialsId True string

Identificador interno do Meisterplan

Tipo
type string
Montante
amount double
On
on True string

Milestone só é válido em combinação com um valor no campo milestoneId. Date só é válido em combinação com um valor no campo dueDate.

ID do marco
milestoneId string

Só é válido em combinação com on: Milestone. O marco deve existir no projeto. Não será criado implicitamente.

Data Para Conclusão
dueDate string

Só é válido em combinação com: Data (formato: AAAA-MM-DD).

Description
description string
Nome
name string

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

Devoluções

Dados Financeiros
FinancialsResponse

Atualizar marcos

Execute uma atualização em uma etapa especificada pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID do marco
milestoneId True string

Identificador interno do Meisterplan

Nome
name string
Date
date string

formato: AAAA-MM-DD

Nome
name string

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

Valor
value string

Devoluções

Atualizar os segmentos de capacidade de uma função

Atualiza os segmentos de capacidade para a função especificada pelo ID fornecido. Para apagar todos os segmentos de capacidade, envie um segmento sem início ou fim e capacidade 0

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID da função
roleId True string

Identificador interno do Meisterplan

start
start date
acabamento
finish date
ETI
fte double

O pedido aceita ETC, horas ou dias.

Dias
days double

O pedido aceita ETC, horas ou dias.

Horas
hours double

O pedido aceita ETC, horas ou dias.

Devoluções

Atualizar prioridades

Este ponto final atualiza as prioridades de projetos e programas.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID
id True string

O valor id pode ser um projeto ou um programa.

Position
position string

A posição pode ser PRIMEIRA ou ÚLTIMA. FIRST é padrão

ID
id True string

O valor id pode ser um projeto ou um programa.

Position
position string

A posição pode ser PRIMEIRA ou ÚLTIMA. FIRST é padrão

ID
id True string

O valor id pode ser um projeto ou um programa.

Position
position string

A posição pode ser PRIMEIRA ou ÚLTIMA. FIRST é padrão

Atualizar programas

Execute uma atualização em um programa especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do programa
programId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Programa representado por um documento JSON.

Devoluções

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

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Projeto representado por um documento JSON.

Devoluções

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

Atualizar recursos

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

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Recurso representado por um documento JSON.

Devoluções

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

Atualizar tipos de OBS

Executa uma atualização em um tipo de OBS especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Nome
name True string

Devoluções

Tipo Obs
ObsTypeResponse

Atualizar uma unidade OBS

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

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Id da Unidade Obs
obsUnitId True string

Identificador interno do Meisterplan

Nome
name string
ID do pai
parentId string

Devoluções

Unidade Obs
ObsUnitResponse

Ausências de atualização

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

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Id de ausência
absenceId True string

Identificador interno do Meisterplan

Start
start string

formato: AAAA-MM-DD

Conclusão
finish string

formato: AAAA-MM-DD

Tipo de Dia de Início
startDayType string
Tipo de Dia de Acabamento
finishDayType string

Devoluções

Ausência
AbsenceResponse

Criar ausências

Use esta 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

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Start
start True string

formato: AAAA-MM-DD

Conclusão
finish True string

formato: AAAA-MM-DD

Tipo de Dia de Início
startDayType string

O padrão é FULL_DAY

Tipo de Dia de Acabamento
finishDayType string

O padrão é FULL_DAY

Devoluções

Ausência
AbsenceResponse

Criar calendários

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

Parâmetros

Name Chave Necessário Tipo Description
Nome
name True string
ID do pai
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

Devoluções

Calendário
CalendarResponse

Criar Equipas

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

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
Carga útil
payload True dynamic

Equipe representada por um documento JSON.

Devoluções

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

Criar evento financeiro real

Retorna o evento financeiro real recém-criado.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

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

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

Devoluções

Realidade Financeira
FinancialActualsResponse

Criar Finanças

Retorna o evento financeiro recém-criado.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Tipo
type True string
Montante
amount True double
On
on True string

Milestone só é válido em combinação com um valor no campo milestoneId. Date só é válido em combinação com um valor no campo dueDate.

ID do marco
milestoneId string

Só é válido em combinação com on: Milestone. O marco deve existir no projeto. Não será criado implicitamente.

Data Para Conclusão
dueDate string

Só é válido em combinação com: Data (formato: AAAA-MM-DD).

Description
description string
Nome
name string

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

Devoluções

Dados Financeiros
FinancialsResponse

Criar funções

Retorna a função criada no sucesso.

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
Carga útil
payload True dynamic

Função representada por um documento JSON.

Devoluções

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

Criar marcos

Devolve o marco recém-criado

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Nome
name True string
Date
date True string

formato: AAAA-MM-DD

Nome
name string

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

Valor
value string

Devoluções

Criar ou atualizar alocações

Este ponto de extremidade permite criar novas alocações e atualizar alocações existentes de um projeto. As alterações só serão feitas para os intervalos de datas especificados, bem como para os recursos e funções especificados.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID
id True string

O id da entidade à qual esta atribuição está ligada. Defina type como RESOLVE_BY_KEY_OR_NAME para resolver chaves de recursos ou nomes de função automaticamente.

Tipo
type string

Controle como o valor no id do campo é interpretado. RESOURCE resolve recursos por UUID. ROLE resolve funções por UUID. RESOLVE_BY_KEY_OR_NAME resolve recursos por chave de recurso ou funções por nome de função.

Função do projeto
projectRole string

O id da função ao qual essa alocação está vinculada. Este campo só é válido em combinação com os tipos RESOURCE ou RESOLVE_BY_KEY_OR_NAME. Se type estiver definido como RESOLVE_BY_KEY_OR_NAME, projectRole será resolvido pelo nome.

Start
start True date
Conclusão
finish True date
FTE
fte double

O pedido aceita ETC, horas ou dias.

Dias
days double

O pedido aceita ETC, horas ou dias.

Horário
hours double

O pedido aceita ETC, horas ou dias.

Devoluções

Repartição
AllocationResponse

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Link de Gerenciamento de Tarefas representado por um documento JSON.

Devoluções

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

Criar ou atualizar o tempo real trabalhado

Este ponto de extremidade permite criar um novo tempo real trabalhado e atualizar o tempo real trabalhado existente de um projeto por uma entidade (recurso ou função). Não atualizaremos o tempo real trabalhado para datas de reserva que não estejam especificadas na solicitação para um determinado projeto e entidade. Com a propriedade mode, você pode controlar se um valor de tempo real trabalhado existente é substituído pelo novo valor ou se seu valor é adicionado à reserva na solicitação. Observe que os dados de tempo real trabalhado em si são independentes de seu cenário. Será o mesmo em todos os cenários para qualquer projeto. Uma solicitação é limitada a 5000 valores de tempo real trabalhado por projeto e recurso/função.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID
id True string

O id da entidade à qual esta entrada de tempo real trabalhado está vinculada. Defina tipo como RESOLVE_BY_KEY_OR_NAME para resolver chaves de recursos e de equipe ou nomes de função automaticamente.

Tipo
type string
ID da Equipa
teamId string

O ID da equipe da entidade à qual essa entrada de tempo real trabalhado está vinculada

Data da Reserva
bookingDate True date

Data desta reserva

Horário
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

Devoluções

Tempo Real Trabalhado
ActualTimeWorkedResponse

Criar ou atualizar tarefa

Cria ou atualiza uma tarefa com os campos fornecidos.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Tarefa representada por um documento JSON.

Criar Programas

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Programa representado por um documento JSON.

Devoluções

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

Criar projetos

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Projeto representado por um documento JSON.

Devoluções

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

Criar recursos

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

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
Carga útil
payload True dynamic

Recurso representado por um documento JSON.

Devoluções

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

Criar tipo de OBS

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

Parâmetros

Name Chave Necessário Tipo Description
Nome
name True string

Devoluções

Tipo Obs
ObsTypeResponse

Criar uma dependência de etapa

Retorna a id da dependência de etapa recém-criada

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Do Milestone ID
fromMilestoneId True string
Para o ID do marco
toMilestoneId True string

Devoluções

Criação de dependência de etapa
MilestoneDependencyCreateResponse

Criar Unidade OBS

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

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Nome
name True string
ID do pai
parentId string

Devoluções

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

Name Chave Necessário Tipo Description
ID
id True string

Excluir alocações

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID de alocação
allocationId True string

Identificador interno do Meisterplan

Excluir ausência

Exclui uma ausência.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Id de ausência
absenceId True string

Identificador interno do Meisterplan

Excluir calendários

Exclui um calendário no 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

Name Chave Necessário Tipo Description
ID do calendário
calendarId True string

Identificador interno do Meisterplan

Excluir dependências de etapas

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID de dependência do marco
milestoneDependencyId True string

Identificador interno do Meisterplan

Excluir equipes

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

Parâmetros

Name Chave Necessário Tipo Description
ID da Equipa
teamId True string

Identificador interno do Meisterplan

Excluir evento financeiro real

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Id do Real Financeiro
actualFinancialEventId True string

Identificador interno do Meisterplan

Excluir Finanças

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Finanças Id
financialsId True string

Identificador interno do Meisterplan

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

Name Chave Necessário Tipo Description
ID da função
roleId True string

Identificador interno do Meisterplan

Exclui um link de gerenciamento de tarefas de um projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Excluir marcos

Exclui uma etapa em um determinado projeto de um cenário.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID do marco
milestoneId True string

Identificador interno do Meisterplan

Excluir programas

Exclui um programa especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do programa
programId True string

Identificador interno do Meisterplan

Excluir projetos

Exclui um projeto em um determinado cenário.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

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

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Excluir tarefa

Exclui uma tarefa em um determinado projeto.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID da Tarefa
taskId True string

Identificador interno do Meisterplan

Excluir tempo real trabalhado por ID

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Id real
actualsId True string

Identificador interno do Meisterplan

Excluir todo o tempo real trabalhado pela ID do projeto

Exclui todo o tempo real trabalhado de um determinado projeto.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Excluir um tipo de OBS por ID

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

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Excluir uma unidade OBS por ID

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

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Id da Unidade Obs
obsUnitId True string

Identificador interno do Meisterplan

Funções de atualização

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

Paths

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

Parâmetros

Name Chave Necessário Tipo Description
ID da função
roleId True string

Identificador interno do Meisterplan

Carga útil
payload True dynamic

Função representada por um documento JSON.

Devoluções

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

Objetivos de Negócio

Devolve todos os objetivos de negócio

Devoluções

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

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Devoluções

Obtenha todas as unidades OBS

Este ponto de extremidade retorna uma lista de todas as unidades OBS para um determinado tipo de OBS.

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Devoluções

Obtenha todos os tipos de OBS

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

Devoluções

Obtenha uma lista de finanças

Devolve uma lista de finanças de um projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

Obtenha uma unidade OBS

Este ponto de extremidade retorna uma única unidade OBS.

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Id da Unidade Obs
obsUnitId True string

Identificador interno do Meisterplan

Devoluções

Unidade Obs
ObsUnitResponse

Obter alocações por ID

Devolve a alocação individual especificada pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID de alocação
allocationId True string

Identificador interno do Meisterplan

Devoluções

Repartição
AllocationResponse

Obter ausências por ID

Devolve a ausência individual especificada pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Id de ausência
absenceId True string

Identificador interno do Meisterplan

Devoluções

Ausência
AbsenceResponse

Obter calendários por ID

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

Parâmetros

Name Chave Necessário Tipo Description
ID do calendário
calendarId True string

Identificador interno do Meisterplan

Devoluções

Calendário
CalendarResponse

Obter cenários por ID

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Devoluções

Scenario
ScenarioResponse

Obter desvios do calendário

Lê desvios para as horas 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 deste momento serão retornados. Se apenas o término for passado, todos os desvios até esse ponto serão retornados.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Start
start date

Data de início do período de filtragem

Conclusão
finish date

Data de término do período de filtragem

Devoluções

Obter Equipa por ID

Devolve a equipa individual especificada pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID da Equipa
teamId True string

Identificador interno do Meisterplan

Devoluções

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

Obter evento financeiro real por ID

Devolve o evento financeiro real individual especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Id do Real Financeiro
actualFinancialEventId True string

Identificador interno do Meisterplan

Devoluções

Realidade Financeira
FinancialActualsResponse

Obter Finanças por ID

Devolve o evento financeiro individual especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Finanças Id
financialsId True string

Identificador interno do Meisterplan

Devoluções

Dados Financeiros
FinancialsResponse

Obter funções por ID

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

Parâmetros

Name Chave Necessário Tipo Description
ID da função
roleId True string

Identificador interno do Meisterplan

Devoluções

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

Retorna um link de gerenciamento de tarefas de um projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

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

Obter marcos por ID

Devolve o marco individual especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID do marco
milestoneId True string

Identificador interno do Meisterplan

Devoluções

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 não existirem segmentos de capacidade.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID da função
roleId True string

Identificador interno do Meisterplan

Devoluções

Obter programa por ID

Retorna o programa individual especificado pela ID fornecida.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do programa
programId True string

Identificador interno do Meisterplan

Devoluções

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

Obter projetos por ID

Retorna o projeto individual especificado pela ID fornecida.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

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

Obter recursos por ID

Retorna o recurso individual especificado pela ID fornecida.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Devoluções

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

Obter Sprint por ID

Devolve o sprint individual especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
Sprint Id
sprintId True string

Identificador interno do Meisterplan

Devoluções

Obter Tarefa por ID

Retorna a tarefa individual especificada pela ID fornecida.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID da Tarefa
taskId True string

Identificador interno do Meisterplan

Devoluções

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

Obter tempo real trabalhado por ID

Devolve o tempo real de trabalho individual especificado pelo ID fornecido.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Id real
actualsId True string

Identificador interno do Meisterplan

Devoluções

Tempo real trabalhado por id
ActualTimeWorkedByIdResponse

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

Retorna um comentário de alocação.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

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

Identificador interno do Meisterplan

Devoluções

Comentário de alocação
AllocationCommentResponse

Obter um comentário do projeto por ID

Retorna um comentário do projeto.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID do comentário
commentId True string

Identificador interno do Meisterplan

Devoluções

Comentário do Projeto
ProjectCommentResponse

Obter um OBS Tipo por ID

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

Parâmetros

Name Chave Necessário Tipo Description
Obs Tipo Id
obsTypeId True string

Identificador interno do Meisterplan

Devoluções

Tipo Obs
ObsTypeResponse

Obter um utilizador por ID

Retorna um usuário.

Parâmetros

Name Chave Necessário Tipo Description
ID do Utilizador
userId True string

Identificador interno do Meisterplan

Devoluções

Obter uma lista de alocações

Devolve uma lista de alocações de um projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

Obter uma lista de ausências

Retorna uma lista de ausências do recurso.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Data de início
startDate date

Data de início do período de filtragem

Data de Conclusão
finishDate date

Inclusive data de término para período de tempo de filtragem.

Devoluções

Obter uma lista de calendários

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

Devoluções

Obter uma lista de cenários

Ele retorna uma lista de cenários

Devoluções

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

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

Parâmetros

Name Chave Necessário Tipo Description
Página Depois
pageAfter string

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

Tamanho da página
pageSize integer

Tamanho da página

ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

Obter uma lista de comentários do projeto

Retorna uma lista de comentários do projeto.

Parâmetros

Name Chave Necessário Tipo Description
Página Depois
pageAfter string

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

Tamanho da página
pageSize integer

Tamanho da página

ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

Obter uma lista de dependências de etapas

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Devoluções

Obter uma lista de equipas

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

Parâmetros

Name Chave Necessário Tipo Description
Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Filter
filter string

Objeto JSON stringified com um subconjunto de propriedades do objeto esperado. Seleciona todos os objetos que correspondem exatamente às propriedades especificadas. Nota: tenha o cuidado de codificar o URL do seu parâmetro. { "resourceKey": string, "name": string }

Devoluções

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

Obter uma lista de eventos financeiros reais

Devolve uma lista de eventos financeiros reais de um projeto.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

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

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

Parâmetros

Name Chave Necessário Tipo Description
ID do calendário
calendarId True string

Identificador interno do Meisterplan

Data de início
startDate date

Data de início

Data de fim
endDate date

Data de fim

Devoluções

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

Name Chave Necessário Tipo Description
Filter
filter string

Objeto JSON stringified com um subconjunto de propriedades do objeto esperado.

Devoluções

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

Obter uma lista de marcos

Devolve uma lista de marcos de um projeto

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Devoluções

Obter uma lista de portfólios

Devolve uma lista de todas as carteiras disponíveis. Se você não tem o direito de visualizar nenhum portfólio, retorna uma lista de todos os portfólios disponíveis que você tem o direito de acessar por meio do seu token de API. Se você não tiver o direito de visualizar qualquer portfólio, uma lista vazia será devolvida.

Devoluções

Obter uma lista de programas

Retorna uma lista de programas no cenário determinado

Parâmetros

Name Chave Necessário Tipo Description
Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Filter
filter string

Objeto JSON stringified 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. Nota: tenha o cuidado de codificar o URL do seu parâmetro. { "programKey": string, "name": string }

ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Devoluções

Obter uma lista de projetos

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Filter
filter string

Objeto JSON stringified com um subconjunto de propriedades do objeto esperado.

Devoluções

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

Obter uma lista de recursos

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

Parâmetros

Name Chave Necessário Tipo Description
Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Filter
filter string

Objeto JSON stringified com um subconjunto de propriedades do objeto esperado.

Devoluções

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

Obter uma lista de tarefas

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Key
key string

Seleciona todos os objetos que correspondem exatamente à chave.

Devoluções

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

Obter uma lista de usuários

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

Parâmetros

Name Chave Necessário Tipo Description
Página Depois
pageAfter string

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

Tamanho da página
pageSize integer

Tamanho da página

Filter
filter string

Objeto JSON stringified com um subconjunto de propriedades do objeto esperado.

Devoluções

Obter uma lista do tempo real trabalhado

Retorna uma lista do tempo real trabalhado para todos os projetos de um cenário específico. Observe que os dados de tempo real trabalhado em si são independentes de seu cenário.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Tamanho da página
pageSize integer

Tamanho da página

Página Depois
pageAfter string

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

Filter
filter string

Objeto JSON stringified com um subconjunto de propriedades do objeto esperado.

Devoluções

Substitua as finanças

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Tipo
type True string
Montante
amount True double
On
on True string

Milestone só é válido em combinação com um valor no campo milestoneId. Date só é válido em combinação com um valor no campo dueDate.

ID do marco
milestoneId string

Só é válido em combinação com on: Milestone. O marco deve existir no projeto. Não será criado implicitamente.

Data Para Conclusão
dueDate string

Só é válido em combinação com: Data (formato: AAAA-MM-DD).

Description
description string
Nome
name string

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

Substituir alocações

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

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

ID
id True string

O id da entidade à qual esta atribuição está ligada. Defina type como RESOLVE_BY_KEY_OR_NAME para resolver chaves de recursos ou nomes de função automaticamente.

Tipo
type string

Controle como o valor no id do campo é interpretado. RESOURCE resolve recursos por UUID. ROLE resolve funções por UUID. RESOLVE_BY_KEY_OR_NAME resolve recursos por chave de recurso ou funções por nome de função.

Função do projeto
projectRole string

O id da função ao qual essa alocação está vinculada. Este campo só é válido em combinação com os tipos RESOURCE ou RESOLVE_BY_KEY_OR_NAME. Se type estiver definido como RESOLVE_BY_KEY_OR_NAME, projectRole será resolvido pelo nome.

Start
start True date
Conclusão
finish True date
FTE
fte double

O pedido aceita ETC, horas ou dias.

Dias
days double

O pedido aceita ETC, horas ou dias.

Horário
hours double

O pedido aceita ETC, horas ou dias.

Substituir ausências

Este ponto de extremidade permite substituir todas as ausências de um recurso. O resultado será o mesmo como se todas as ausências existentes fossem eliminadas e as ausências passadas fossem criadas novamente. Você pode usar os parâmetros de consulta 'start' e 'end' para especificar um intervalo de tempo para substituir ausências existentes. Se você não usar esses parâmetros, todas as ausências serão substituídas pelas ausências recém-enviadas.

Parâmetros

Name Chave Necessário Tipo Description
ID do recurso
resourceId True string

Identificador interno do Meisterplan

Start
start date

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

Fim
end date

Incluindo a data final do período de substituição.

Start
start True string

formato: AAAA-MM-DD

Conclusão
finish True string

formato: AAAA-MM-DD

Tipo de Dia de Início
startDayType string

O padrão é FULL_DAY

Tipo de Dia de Acabamento
finishDayType string

O padrão é FULL_DAY

Substituir eventos financeiros reais

Substitui eventos financeiros reais de um determinado projeto dentro de um cenário. Um pedido está limitado a 5000 eventos financeiros reais por projeto.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

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

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

Substituir marcos

Substitui marcos de um determinado projeto dentro de um cenário.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Nome
name True string
Date
date True string

formato: AAAA-MM-DD

Nome
name string

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

Valor
value string

Substituir tarefas

Este 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 irá sincronizar as tarefas do projeto com esta lista usando a chave de tarefa como identificador. Isto significa:

  • As tarefas atualmente no sistema, mas não na sua lista, serão excluídas. - Serão criadas tarefas na sua lista que não existam no sistema. - As tarefas que existem tanto no sistema como na sua lista serão atualizadas, caso haja alterações.

Parâmetros

Name Chave Necessário Tipo Description
ID do cenário
scenarioId True string

Identificador interno do Meisterplan

ID do projeto
projectId True string

Identificador interno do Meisterplan

Solicitação de substituição de tarefa
tasksReplaceRequest True dynamic

Tarefa representada por um documento JSON.

Acionadores

Criar Webhook

Cria um webhook pelos campos fornecidos e retorna o recém-criado. Atualmente, 1000 webhooks são suportados por sistema.

Criar Webhook

Cria um webhook pelos campos fornecidos e retorna o recém-criado. Atualmente, 1000 webhooks são suportados por sistema.

Parâmetros

Name Chave Necessário Tipo Description
Tipos de Eventos
eventTypes True array of string

Pelo menos um tipo de evento precisa ser fornecido.

ID do cenário
scenarioId True string

O cenário que você deseja assinar.

ID do projeto
projectId string

O projectId é opcional. Só é necessário se quiser subscrever um projeto específico.

Devoluções

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

Definições

UserRefResponse

Name Caminho Tipo Description
ID de utilizador
id string
Nome de exibição do usuário
displayName string

ListResponseRoleCapacityResponse

Name Caminho Tipo Description
Itens
items array of RoleCapacityResponse

RoleCapacityResponse

Name Caminho Tipo Description
start
start date

Data de início deste segmento de capacidade de função. Opcional.

acabamento
finish date

Data de término deste segmento de capacidade de função. Opcional.

ETI
fte double

Capacidade do papel em ETI

MilestoneResponse

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

formato: AAAA-MM-DD

Fase do Projeto
projectPhase ProjectPhaseResponse
Situação
status StatusResponse

ProjectPhaseResponse

Name Caminho Tipo Description
Nome
name string

StatusResponse

Name Caminho Tipo Description
Valor
value string
Nome de exibição
displayName string

FinançasCategoriaResposta

Name Caminho Tipo Description
Nome
name string

FinançasResposta

Name Caminho Tipo Description
ID
id string
Tipo
type string
Montante
amount double
Calendário Financeiro
timing FinancialsTimingResponse
Description
description string
Categoria Finanças
category FinanceCategoryResponse

FinançasTimingResposta

Name Caminho Tipo Description
On
on string
ID do marco
milestoneId string

Presente apenas quando o tipo de temporização é igual a Milestone

Data Para Conclusão
dueDate date

FinancialActualsResponse

Name Caminho Tipo Description
ID
id string
Tipo
type string
Montante
amount double
Data da Reserva
bookingDate string

formato: AAAA-MM-DD

Description
description string
Categoria Finanças
category FinanceCategoryResponse

AllocatedEntityResponse

Name Caminho Tipo Description
ID
id string

O id da entidade à qual esta atribuição está ligada

Tipo
type string

O tipo de entidade para esta alocação

Função do projeto
projectRole string

Só será definido se type for igual a RESOURCE

AllocationResponse

Name Caminho Tipo Description
ID
id string

ID desta alocação

Entidade alocada
allocatedEntity AllocatedEntityResponse
Segmentos
segments array of AllocationSegmentResponse

Os segmentos de tempo da alocação

AllocationSegmentResponse

Os segmentos de tempo da alocação

Name Caminho Tipo Description
Start
start date

Data de início desta atribuição

Conclusão
finish date

Data de fim desta atribuição

Horário
hours double

Valor de alocação em horas

ActualTimeWorkedResponse

Name Caminho Tipo Description
Link da entidade real
bookedEntity ActualsEntityLinkResponse
Reservas
bookings array of ActualsBookingResponse

Data de reserva e horas desta entrada real trabalhada

ActualsBookingResponse

Data de reserva e horas desta entrada real trabalhada

Name Caminho Tipo Description
Id
id string

ID de reserva desta entrada de tempo real trabalhado

Data da Reserva
bookingDate date

Data de reserva desta entrada efetiva trabalhada

Horário
hours double

Tempo real trabalhado em horas

Tipo de Custo
costType string
Custo por hora
costPerHour double

ActualsEntityLinkResponse

Name Caminho Tipo Description
ID
id string

O id da entidade à qual esta entrada de tempo real trabalhado está ligada

Tipo
type string

O tipo de entidade para esta entrada de tempo real trabalhado

ID da Equipa
teamId string

O ID da equipe da entidade à qual essa entrada de tempo real trabalhado está vinculada

MilestoneDependencyCreateResponse

Name Caminho Tipo Description
ID
id string

CalendarDeviationResponse

Name Caminho Tipo Description
Start
start date
Conclusão
finish date
Capacidade Relativa
relativeCapacity double

ListResponseCalendarDeviationResponse

Name Caminho Tipo Description
Itens
items array of CalendarDeviationResponse

AusênciaResposta

Name Caminho Tipo Description
ID
id string

O id da ausência

Data de início
start date

Data de início desta ausência

Data de Conclusão
finish date

Data de término desta ausência

Tipo de Dia de Ausência Inicial
startDayType string
Tipo de Dia de Ausência de Acabamento
finishDayType string

ObsTypeResponse

Name Caminho Tipo Description
ID
id string
Nome
name string

ObsUnitResponse

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

O nome para exibição é processado da mesma forma que na interface do usuário do aplicativo Meisterplan

ID do pai
parentId string

CalendarResponse

Name Caminho Tipo Description
ID
id string
Nome
name string
ID do pai
parentId string
Caminho
path string
Horário de Funcionamento
workingHours WorkingHoursResponse

Horário de TrabalhoResposta

Name 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

Name Caminho Tipo Description
Cursor
cursor string

Paginação

Name Caminho Tipo Description
Cursor
after Cursor

BasicUserGroupResponse

Name Caminho Tipo Description
ID do grupo
id string

ID de um grupo de utilizadores.

Nome do Grupo
name string

Nome de um grupo de usuários.

LinkedResourceResponse

Name Caminho Tipo Description
ID
id string

ID do recurso vinculado.

Chave de recurso
resourceKey string

Chave de recurso do recurso vinculado.

PaginatedResponseUserResponse

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

Resposta do usuário

Name Caminho Tipo Description
ID
id string
Nome de utilizador
userName string
ID externo
externalId string
Active
active boolean
endereço de e-mail
emailAddress string
Apelido
lastName string
Nome Próprio
firstName string
Nome de exibição
displayName string
Localidade
locale string
groups
groups array of BasicUserGroupResponse
Último Login
lastLogin date-time
E-mail verificado
emailVerified boolean
Recurso vinculado
linkedResource LinkedResourceResponse
A palavra-passe nunca expira
passwordNeverExpires boolean

SprintResponse

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

ListResponseScenarioResponse

Name Caminho Tipo Description
Itens
items array of ScenarioResponse

ScenarioResponse

Name Caminho Tipo Description
ID
id string
Nome
name string

ListResponseRoleWithRoleCapacityResponse

Name Caminho Tipo Description
Itens
items array of RoleWithRoleCapacityResponse

RoleWithRoleCapacityResponse

Name Caminho Tipo Description
roleId
roleId string

O ID da função.

segments
segments array of RoleCapacityResponse

Os segmentos de capacidade da função.

ListResponseMilestoneResponse

Name Caminho Tipo Description
Itens
items array of MilestoneResponse

ListResponseFinancialsResponse

Name Caminho Tipo Description
Itens
items array of FinancialsResponse

ListResponseFinancialActualsResponse

Name Caminho Tipo Description
Itens
items array of FinancialActualsResponse

PaginatedResponseProjectCommentResponse

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

ProjectCommentResponse

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

ListResponseAllocationResponse

Name Caminho Tipo Description
Itens
items array of AllocationResponse

AllocationCommentEntityResponse

Name Caminho Tipo Description
ID
id string

O id da entidade à qual este comentário de alocação está vinculado

Tipo
type string

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

AllocationCommentResponse

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

PaginatedResponseAllocationCommentResponse

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

PaginatedResponseActualTimeWorkedResponse

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

ActualTimeWorkedByIdResponse

Name Caminho Tipo Description
Link da entidade real
bookedEntity ActualsEntityLinkResponse
Id
id string

ID de reserva desta entrada de tempo real trabalhado

Data da Reserva
bookingDate date

Data de reserva desta entrada efetiva trabalhada

Horário
hours double

Tempo real trabalhado em horas

Tipo de Custo
costType string
Custo por hora
costPerHour double

PaginatedResponseProgramGetAllResponse

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

ProgramGetAllResponse

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

Deve ser único. Se estiver vazio, o valor será gerado.

MilestoneDependencyResponse

Name Caminho Tipo Description
ID
id string
Referência do marco
from MilestoneReferenceResponse
Referência do marco
to MilestoneReferenceResponse

MilestoneReferenceResponse

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

PaginatedResponseMilestoneDependencyResponse

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

ListResponseAbsenceResponse

Name Caminho Tipo Description
Itens
items array of AbsenceResponse

ListResponsePortfolioResponse

Name Caminho Tipo Description
Itens
items array of PortfolioResponse

PortfolioResponse

Name Caminho Tipo Description
ID
id string
Nome
name string

ListResponseObsTypeResponse

Name Caminho Tipo Description
Itens
items array of ObsTypeResponse

ListResponseObsUnitResponse

Name Caminho Tipo Description
Itens
items array of ObsUnitResponse

ListResponseCalendarResponse

Name Caminho Tipo Description
Itens
items array of CalendarResponse

CalendarExceptionResponse

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

ListResponseCalendarExceptionResponse

Name Caminho Tipo Description
Itens
items array of CalendarExceptionResponse

BusinessGoalDefiniçãoResponse

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

ListResponseBusinessGoalDefinitionResponse

Name Caminho Tipo Description
Itens
items array of BusinessGoalDefinitionResponse

SubGoalDefinitionResponse

Name Caminho Tipo Description
Nome
name string
Nome de exibição
displayName string