Ir para o conteúdo principal
Adaptive Planning
Última atualização: 2023-06-23
Métodos de API

Métodos de API

Métodos de API

Os seguintes métodos têm suporte na API do Adaptive Planning:
Métodos de criação, atualização e leitura de metadados e dados
  • createAccount : permite que os usuários criem novas contas LR, personalizadas ou de suposição
  • createDimension : permite que os usuários criem novas dimensões.
  • createDimensionValue : permite que os usuários criem novos valores de dimensão.
  • createLevel : permite que os usuários criem novos níveis.
  • createUser : permite que os usuários criem novos usuários
  • customReportValues : retorna um conjunto de dados para os critérios de relatório solicitados na instância solicitada.
  • exportAccounts : recupera metadados sobre contas no sistema
  • exportActiveCurrencies : recupera metadados sobre moedas que foram configuradas no sistema.
  • exportAttributes : recupera metadados para todos os atributos personalizados no sistema
  • exportCalendar : recupera metadados para informações de calendário.
  • exportConfigurableModelData : recupera um conjunto de linhas da planilha modelada solicitada na versão e instância solicitadas.
  • exportCustomerLogo : recupera um URL que pode ser usado para recuperar o logotipo do cliente
  • exportData : recupera um conjunto de valores de uma versão especificada
  • exportDimensionFamilies : recupera metadados sobre como as dimensões estão relacionadas às contas no sistema
  • exportDimensions : recupera metadados sobre dimensões personalizadas no sistema
  • exportDimensionMapping : exporta regras de mapeamento de dimensões definidas pelo usuário.
  • exportGroups: recupera a lista completa de todos os grupos definidos para uma determinada instância.
  • exportInstances : recupera metadados sobre as instâncias às quais um usuário tem acesso (se o usuário tem acesso a várias instâncias)
  • exportLevels : recupera metadados sobre os níveis da organização no sistema
  • exportLocales : retorna uma lista de todos os parâmetros regionais de uma empresa.
  • exportModeledSheet : retorna a definição da planilha modelada fornecida
  • exportRoles : recupera metadados sobre funções no sistema
  • exportPermissionSets : recupera metadados sobre conjuntos de permissões no sistema
  • exportSecurityAudit : recupera registros de auditoria de evento de segurança para um intervalo de tempo especificado
  • exportSheetDefinition : recupera a definição de uma planilha modelada ou de cubo
  • exportSheet : recupera uma lista de todas as planilhas com tipo, ID e nome
  • exportTime : retorna metadados de tempo para uma versão específica ou para todas as versões, se nenhuma for especificada
  • exportTransactionDefinition : recupera a definição da planilha de transação
  • exportUsers : recupera metadados sobre usuários no sistema
  • exportVersions : recupera metadados sobre versões no sistema
  • importDimensionMapping : importa valores de dimensão derivada.
  • importGroups : importa um conjunto de grupos de usuários.
  • importModeledSheet : importa a planilha modelada fornecida
  • publishChanges : permite que os usuários publiquem alterações não publicadas.
  • unpublishedChangesStatus : permite que os usuários determinem se a publicação de administrador está habilitada e quantas alterações não publicadas eles têm.
  • updateAccessRules : permite que os usuários atualizem as regras de acesso para instâncias que usam segurança com regra de acesso.
  • updateAccount : permite que os usuários atualizem as propriedades de contas LR, personalizadas ou de suposição existentes.
  • updateAssociations : permite que os usuários atualizem a propriedade de nível de usuário e as associações de dimensão de usuário.
  • updateDimension : permite que os usuários atualizem as propriedades de dimensões existentes.
  • updateDimensionValue : permite que os usuários atualizem as propriedades dos valores de dimensão existentes.
  • updateLevel : permite que os usuários atualizem as propriedades dos níveis existentes.
  • updateUser : permite que os usuários atualizem as informações do usuário (não funciona depois que os usuários sincronizam do Workday).
Atualização em massa de metadados
  • updateAccounts: permite que os usuários atualizem contas LR em massa carregando um arquivo XML.
  • updateAttributes: permite que os usuários atualizem os valores de atributo em massa carregando um arquivo XML.
  • updateDimensions : permite que os usuários atualizem dimensões e valores de dimensão em massa carregando um arquivo XML.
  • updateLevels : permite que os usuários atualizem os níveis em massa carregando um arquivo XML.
Métodos de envio de dados
  • importConfigurableModelData : envia um conjunto de linhas para uma planilha modelada
  • importCubeData : envia um conjunto de dados para serem inseridos em uma planilha de cubo.
  • importStandardData : envia um conjunto de dados a serem inseridos em contas padrão (contas LR, suposições ou contas personalizadas)
  • importTransactions : envia um conjunto de transações a serem inseridas nos dados de transações, se o recurso de transações foi habilitado
  • eraseActuals : apaga dados numéricos em períodos especificados e contas de uma versão de valores reais.
  • eraseData: apaga dados numéricos de um plano ou versão de valores reais para o conjunto de contas especificado em um determinado intervalo de tempo.
  • recalculateSheet : recalcula planilhas com a propriedade Recalcular sob demanda.