Referência de IDs internas

Você pode incluir IDs internas em uma solicitação de API para obter metadados para os métodos de criação, atualização e leitura. Quando você faz solicitações para esses métodos, use as chamadas à API de exportação associadas para obter as IDs que sua solicitação requer. As solicitações de todas as APIs na tabela a seguir exigem um elemento de credenciais.

Exemplo

Você deve passar a ID de dimensão para atualizar uma dimensão na solicitação de API updateDimensions . Você pode passar a ID de dimensão "7" para atualizar a dimensão "Formação
".


<dimensions>
      <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      --------------------------
      </dimension>
</dimensions>

A ID de dimensão "7" para "Educação" é obtida na resposta da API exportDimensions .


<response success="true">
 <output>
   <dimensions>
     <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35">
      --------------------------------------------
    </dimension>
  </output>
 </response>

Exportar APIs e IDs de resposta

API	Adaptive Planning IDs internas em resposta	Metadados recuperados
exportAccounts	ID da conta e ID de atributo de conta As IDs de conta podem ser usadas para identificar contas em outras chamadas de API, como exportDimensionFamilies. O elemento de planilha é opcional. Se você inclui o elemento de planilha, deve passar a ID do sistema interno da planilha na sua solicitação. Consulte exportSheet.	Lista de todas as contas, incluindo todos os tipos de conta: suposições, contas de cubo, contas personalizadas, contas LR, contas de métrica e contas modeladas.
exportActiveCurrencies	ID da moeda Isso pode ser usado para identificar de forma exclusiva a moeda e pode ser usado na API customReportValues .	Lista de todas as moedas que foram configuradas no sistema.
exportAttributes	ID de atributo e ID de elemento attributeValue	Lista de todos os atributos no sistema.
exportDimensions	ID de dimensão e sua ID de elemento dimensionValue Isso pode ser usado para identificar dimensões em outras chamadas de API, como exportDimensionFamilies.	Lista de todas as dimensões no sistema.
exportGroups	ID do grupo de usuários e ID do usuário que é proprietário deste grupo de usuários (definida somente quando isGlobal="false").	Lista de todos os grupos definidos para a instância especificada. Isso inclui os grupos definidos como globais em toda a instância e os definidos pelos usuários.
exportLevels	ID do nível	Lista de todos os níveis da organização no sistema.
exportPermissionSets Disponível na API v25+.	ID do conjunto de permissões É usado para identificar o conjunto de permissões atribuído a um usuário na chamada à API exportUsers.	Lista de todos os conjuntos de permissões na instância.
exportRoles Disponível na API v25 e anteriores. Não disponível na API v25+.	ID da função É usado para identificar a função atribuída a um usuário na chamada à API exportUsers.	Lista de todas as funções na instância.
exportSheet	ID da planilha (pode ser elemento de planilha padrão, de cubo e modelada) Isso pode ser usado para identificar planilhas em outras chamadas de API, como exportSheetDefinition.	Lista de todas as planilhas definidas para a instância especificada. Isso inclui planilhas "incompletas" e planilhas atribuídas a usuário.
exportTime	ID do período temporal do saldo inicial	Metadados de tempo para uma versão específica ou para todas as versões, se nenhuma for especificada.
exportTransactionDefinition	IDs para elementos de dimensão, seletor de texto e valor.	A definição (colunas disponíveis) das transações na instância.
exportUsers	ID de usuário e ID de função atribuídas a este usuário	Lista de todos os usuários na instância.
exportVersions	ID da versão ou da pasta Todas as IDs são exclusivas entre todas as versões, subversões e pastas.	Um documento XML que descreve o conjunto de todas as versões definidas na instância que não são ocultadas do usuário solicitante após a verificação.