createDimensionValue
Sem suporte na API v20+. Use updateDimensions.
Categoria
| Modificação de metadados |
Descrição
| Crie um valor de dimensão. Se for bem-sucedida, a API retorna detalhes para a dimensão e todos os valores de dimensão, incluindo o que acabou de ser criado. |
Permissões obrigatórias para invocar
| Modelo |
Parâmetros obrigatórios na solicitação
| Credenciais |
A solicitação desse método contém uma etiqueta de credenciais para identificar e autorizar o usuário que está fazendo a chamada. O usuário deve ter permissão de modelo para criar a dimensão. Esse método retorna um erro se há alterações não publicadas.
Formato da solicitação
<?xml version='1.0' encoding='UTF-8'?> <call method="createDimensionValue" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <dimensionValue dimensionId="10" name="New Dimension Value"> <attributes> <attribute attributeId="20" valueId="170" /> </attributes> </dimensionValue> </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) | |||
dimensionValue element
| |||
Nome da etiqueta
| dimensionValue | ||
Descrição
| Especifica um valor de dimensão a ser criado. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
dimensionId | S | A ID da dimensão. A dimensionId ou a parentId devem ser especificadas | 34 |
parentId | N | A ID do valor da dimensão pai. A dimensionId ou parentId deve ser especificada. | 220 |
nome | S | O nome do valor de dimensão. | NewDimensionValue |
shortName | N | A descrição do valor da dimensão. | NewDimensionValue- ShortName |
descrição | N | A descrição do valor da dimensão. | Este é um NewDimensionValue |
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
|
Conteúdo do elemento
| |||
Um ou mais elementos de atributo. | |||
elemento de atributos
| |||
Nome da etiqueta
| atributo | ||
Descrição
| Contêiner para um ou mais elementos de atributo de 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 |
valueID | S | A ID exclusiva do valor do atributo de dimensão gerado pelo sistema. Se esse valor é 0, esse atributo é removido da conta. | 170 |
Conteúdo do elemento
| |||
(nenhum) | |||
Formato da resposta
Estes são exemplos de respostas para criação bem-sucedida e malsucedida de um valor de dimensão.
Exemplo de êxito
<?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"> <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="" /></dimensionValue> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> <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> </dimensions> </output> </response>
Exemplo de erro
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message type="ERROR" key="invalid-attributevalueid" values="-50">Invalid attribute value id: "-50"</message> </messages> </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
| descriçã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 |
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 |
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 |
nome | S | O rótulo do valor do membro da dimensão, conforme exibido em relatórios e usado em fórmulas. | 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" deste valor de dimensão, cujos membros são consolidados implícitos neste valor | |||
elemento de atributos
| |||
Nome da etiqueta
| atributos | ||
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 | S | O valor do atributo de dimensão. | Techl |
Conteúdo do elemento
| |||
(nenhum) | |||