exportDimensions
Esta API oferece suporte somente a usuários Conceito: regras de acesso na API v22 e superiores.
Categoria
| Recuperação de metadados |
Descrição
| Retorna metadados para a lista completa de todas as dimensões no sistema. |
Permissões obrigatórias para invocar
| Nenhum (devem ser credenciais válidas para a instância) |
Parâmetros obrigatórios na solicitação
| Credenciais |
A solicitação desse método contém apenas uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. Depois de verificado, o método retorna um documento XML que descreve o conjunto completo de dimensões personalizadas no sistema, incluindo todos os valores dos membros. Esse método não retorna nenhuma das dimensões do sistema obrigatórias, como Versão, Tempo ou Contas, cada uma delas disponível em sua própria chamada de API de metadados. Os valores de membro em uma dimensão são retornados em forma de árvore, com os membros pai contendo seus filhos.
Você pode localizar IDs de dimensão usando um
exportDimensions
a solicitação sem o elemento dimensionIDs. Isso produz uma lista de todas as dimensões e suas IDs. Revise a resposta para localizar as IDs de dimensão de que você precisa. As IDs de dimensão não estão disponíveis no Adaptive Planning
interface de usuário da Web.Formato da solicitação
<?xml version='1.0' encoding='UTF-8'?> <call method="exportDimensions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include versionName="Budget 2004" dimensionIDs="1,2,4,5" dimensionValues="true"/> </call>
elemento de credenciais
| |||
Nome da etiqueta
| credenciais | ||
Descrição
| Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
login | S | O nome de logon do usuário que invoca o método de API. Este usuário deve ter as permissões necessárias para invocar o método | sampleuser@company.com |
senha | S | A senha do usuário que invoca o método de API. | my_password |
parâmetros regionais | N | Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado. | fr_FR |
instanceCode | N | Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning , esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances. | MYINSTANCE1 |
Conteúdo do elemento
| |||
(nenhum) | |||
incluir elemento
| |||
Nome da etiqueta
| incluir | ||
Descrição
| Representa um conjunto de indicadores que indicam quais aspectos das informações de "valores de dimensão" devem ser incluídos ou excluídos da resposta. Esse elemento é opcional: se não estiver presente, o valor por padrão fica em branco (ou todas as versões) para versionName/versionID. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
versionName Atualizado na API v18 | N | Indica se a resposta deve excluir valores de dimensão indisponíveis para o nome da versão solicitada. O valor por padrão, se o elemento ou seu atributo não estiver presente, é retornar todas as dimensões e valores. Se um nome de versão é especificado, os valores de dimensão que não estão disponíveis para a versão especificada não serão retornados. Se o nome da versão especificada não é encontrado, essa API retorna um erro. Se os atributos versionName e versionID são passados, versionID é ignorado. <?xml version='1.0' Coding='UTF-8'?> <response Success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate=" 0" listDimension="0" leaveSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engenharia" shortName=""> <dimensionValue id=" 52" name="QA" description="Garantia de qualidade" shortName="" /> <dimensionValue id="53" name="Dev" description="Development" shortName="" />> <dimension id="7" name="Educação" shortName="" autoCreate="0" listDimension="1" leaveSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name ="Formado" description="Pós-graduação" shortName=""> <attributes> <attribute attributeId="21" name="Tipo de formação" valueId="197" value="Técnico1" /> </attributes> </dimensionValue > <dimensionValue id="33" name="Mestrado" description="Mestrado" shortName=""> <attributes> <attribute attributeId="21" name="Tipo de formação" valueId="196" value="Gestão" /> </attribu tes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName="" /> ; Ao especificar uma versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão. | Orçamento de 2004 |
versionID Com suporte na API v17 e atualizado na API v18 | N | Igual a versionName (acima), exceto que usa um número de ID de versão como parâmetro. Indica se a resposta deve excluir valores de dimensão indisponíveis para a versão solicitada. O valor por padrão, se o elemento ou seu atributo não estiver presente, é retornar todas as dimensões e valores. Se uma ID de versão é especificada, os valores de dimensão que não estão disponíveis para a versão especificada não serão retornados. Se a ID de versão especificada não é encontrada, essa API retorna um erro. Se os atributos versionName e versionID são passados, versionID é ignorado. Ao especificar uma versão, a chamada será bem-sucedida somente se o usuário tiver acesso à versão. | 3 |
dimensionIDs Com suporte na API v17 + | N | Uma lista de IDs que serão exibidas na resposta da API. Isso filtra uma dimensão, mas não um valor de dimensão. | "1,2,3,14" |
atributos | N | Indica se a resposta deve incluir os atributos na resposta para cada dimensão simples. | false |
inacessívelValores Com suporte na API v18 + | N | Indica se a resposta deve incluir valores inacessíveis ao usuário atual. O valor por padrão é falso. Somente usuários com as permissões "Modelagem" ou "Importar para todos os níveis" podem definir essa opção como verdadeira. | 1 |
dimensionValues Com suporte na API v22+ | N | Indica se a resposta deve incluir valores de dimensão para cada dimensão. O valor por padrão é verdadeiro. Se definida como falsa, retorna apenas as dimensões filtradas, não os valores de dimensão. Se dimensionValues não faz parte do elemento include, retorna todas as dimensões e os valores delas. Se o elemento de inclusão não fizer parte da solicitação, todas as dimensões e os respectivos valores serão retornados. | false |
displayNameEnabled
Disponível somente na API v30+ para instâncias que habilitam o nome de exibição. | N | displayNameEnabled=true indica que exportDimensions deve respeitar as propriedades de nome de exibição de code , displayNameType e description quando Habilitar nome de exibição está ATIVADO para a instância.displayNameEnabled=false indica que a API exportDimensions deve continuar seguindo o contrato de API anterior à versão 30, mesmo quando a opção Habilitar nome de exibição está ATIVADA para a instância. A API exportDimensions ignora as propriedades de nome de exibição code , displayNameType e description .O valor por padrão para displayNameEnabled é "falso". | verdadeiro |
Conteúdo do elemento
| |||
(nenhum) | |||
Formato da resposta
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""/> <dimensionValue id="52" name="QA" description="Quality Assurance" shortName=""/> <dimensionValue id="53" name="Dev" description="Development" shortName=""/> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" seqNo="21"> <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue> <dimensionValue id="33" name="Masters" description="Masters degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> </attributes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName=""/> </dimension> <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" seqNo="14" property1="Latitude" property2="Longitude"> <dimensionValue id="521" name="United States" description="USA" shortName=""> <dimensionValue id="555" name="Alabama" description="1" shortName=""> <dimensionValue id="579" name="205" description="1" shortName=""> <dimensionValue id="4718" name="35004" description="1" shortName=""> <properties> <property name="Latitude" value="33.606" /> <property name="Longitude" value="-86.502" /> </properties> </dimensionValue> <dimensionValue id="4719" name="35005" description="" shortName=""> <properties> <property name="Latitude" value="33.593" /> <property name="Longitude" value="-86.96" /> </properties> </dimensionValue> <dimensionValue id="5073" name="35006" description="" shortName="" /> <dimensionValue id="5074" name="35007" description="" shortName="" /> </dimensionValue> </dimensionValue> <properties> <property name="Latitude" value="37.0902" /> <property name="Longitude" value="95.7129" /> </properties> </dimensionValue> </dimension> </dimensions> </output> </response>
As dimensões são ordenadas por nome.
elemento de resposta
| |||
Nome da etiqueta
| resposta | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
êxito | S | Verdadeiro ou falso, indicando se a chamada à API foi bem-sucedida ou não. Mesmo as chamadas bem-sucedidas podem conter mensagens de aviso na resposta. | verdadeiro |
obsoleto | N | Se presente na etiqueta de resposta e definido como verdadeiro, esse atributo indica que a versão do método ou da API que está sendo invocada se tornou obsoleta e está oficialmente obsoleta. Embora continue a funcionar neste momento, pode deixar de funcionar em breve. Normalmente, esse atributo não está presente. | false |
Conteúdo do elemento
| |||
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório. | |||
elemento de saída
| |
Nome da etiqueta
| saída |
Atributos do elemento
| |
(nenhum) | |
Conteúdo do elemento
| |
Um único elemento de contas. Esse invólucro de saída é padrão em todas as respostas de API e inclui a saída válida de qualquer chamada de API bem-sucedida. | |
elemento de dimensões
| |
Nome da etiqueta
| dimensões |
Descrição
| Contêiner para um ou mais elementos de dimensão. |
Atributos do elemento
| |
(nenhum) | |
Conteúdo do elemento
| |
Um ou mais elementos de dimensão. | |
elemento de dimensão
| |||
Nome da etiqueta
| dimensão | ||
Descrição
| Representa uma única dimensão personalizada que está sendo retornada em resposta a uma chamada à API exportDimensions. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
ID | S | O número da ID do sistema interno da dimensão. Isso pode ser usado para identificar dimensões em outras chamadas de API, como exportDimensionFamilies. | 16 |
nome | S | O nome da dimensão, como aparece em relatórios e planilhas. | Cliente |
código
Disponível somente na API v39+. | N | O nome da dimensão, como aparece em relatórios e planilhas. Ele só será exibido com a API v39+ | Cliente |
displayNameType
Disponível somente na API v30+ para instâncias que habilitam o nome de exibição. | N | A representação interna do formato de nome de exibição selecionado para valores nas páginas de administração da dimensão.
| NOME |
shortName | N | O nome curto da dimensão, se houver, conforme inserido em Administração de dimensões. | cust. |
autoCreate | S | 1 se a dimensão selecionada tem o campo "A importação de dados cria automaticamente valores de dimensão" definido; 0, caso contrário. | 0 |
listDimension | S | 1 se a dimensão selecionada é uma dimensão de lista; 0, caso contrário. | 1 |
keepSorted | S | 1 se a dimensão selecionada é mantida classificada; 0, caso contrário. | 1 |
useOnLevels | S | 1 se a dimensão selecionada pode ser usada em níveis; 0, caso contrário. | 1 |
seqNo Adicionado na API v17, mas reservado para uso futuro. | |||
descrição
Disponível somente na API v30+ para instâncias que habilitam o nome de exibição. | N | A descrição conforme inserida em Administração da dimensão. | |
Conteúdo do elemento
| |||
Zero ou mais elementos dimensionValue. Cada elemento dimensionValue incluído representa um valor de dimensão raiz na dimensão, um valor que não tem valor pai. | |||
dimensionValue element
| |||
Nome da etiqueta
| dimensionValue | ||
Descrição
| Representa um valor de membro único de uma dimensão personalizada que está sendo retornado em resposta a uma chamada à API exportDimensions. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
ID | S | O número de ID do sistema interno para este valor de membro da dimensão. | 34 |
código
Disponível somente na API v30+ para instâncias que habilitam o nome de exibição. | N | O código para o valor do membro da dimensão, se houver, conforme inserido em Administração de dimensões. | Uma empresa |
nome | S | O rótulo do valor do membro da dimensão, conforme exibido em relatórios e usado em fórmulas. | Uma empresa |
displayName
Disponível somente na API v30+ para instâncias que habilitam o nome de exibição. | N | O nome de exibição do valor do membro, conforme derivado de displayNameType. | Uma empresa |
shortName | N | O nome curto do valor de dimensão, se houver, conforme inserido em Administração de dimensão | A |
descrição | N | A descrição do valor da dimensão, se houver, conforme inserida em Administração de dimensão | Uma corporação |
Conteúdo do elemento
| |||
Zero ou mais elementos dimensionValue opcionais. Cada elemento dimensionValue incluído representa um "valor de dimensão filho" desse valor de dimensão, cujos membros são consolidados implícitamente nesse valor. Um elemento de propriedades opcional. | |||
elemento de propriedades
| |||
Nome da etiqueta
| propriedades | ||
Descrição
| Elemento opcional que contém elementos de propriedade. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
(nenhum) | |||
Conteúdo do elemento
| |||
Até cinco elementos de propriedade | |||
elemento de propriedade
| |||
Nome da etiqueta
| propriedade | ||
Descrição
| Especifica uma propriedade personalizada. Os valores do elemento de propriedade contêm apenas caracteres numéricos. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
nome | S | O nome da propriedade. | Latitude |
valor | N | O valor da propriedade. | 33.6015 |
Conteúdo do elemento
| |||
(nenhum) | |||
elemento de atributos
| |||
Nome da etiqueta
| atributos | ||
Descrição
| Contêiner para um ou mais elementos de atributo de dimensão. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
(nenhum) | |||
Conteúdo do elemento
| |||
Um ou mais elementos de atributo. | |||
elemento atributo
| |||
Nome da etiqueta
| atributo | ||
Descrição
| Contêiner para elemento de atributo de uma dimensão. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
attributeID | S | A ID do atributo de dimensão gerada pelo sistema. | 20 |
nome | S | O nome do atributo de dimensão | Tipo de formação |
valueID | S | A ID exclusiva do valor do atributo de dimensão gerado pelo sistema. | 170 |
valor
Com suporte na API v34 quando a configuração de Nome de exibição vigente está ATIVADA. | S | O valor do atributo de dimensão. | Tech1 |
valueCode
Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34. | N | O código de valor deste atributo.
Para API v32 e API v33, valueCode só é significativo quando:
| Tech1 |
valueName
Disponível somente na API v32 e API v33 para instâncias que habilitam o nome de exibição. Sem suporte na API v34. | N | O nome do valor deste atributo.
Para API v32 e API v33, valueName só faz sentido quando:
| Tech1 |
valueDisplayName
Disponível somente na API v32+ para instâncias que habilitam o nome de exibição. | S | Para a API v32 e versões mais recentes, valueDisplayName é significativo somente quando:
| Tech1 |
Conteúdo do elemento
| |||
(nenhum) | |||