updateLevel
Sem suporte na API v20+. Use updateLevels.
Categoria
| Modificação de metadados |
Descrição
| Atualize um nível. Se for bem-sucedida, a API retorna os detalhes do nível que acabou de ser atualizado. |
Permissões obrigatórias para invocar
| Estrutura organizacional |
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 estrutura organizacional para criar o nível.
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="updateLevel" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <level id="41" name="New Level Name" shortName="NewLvlName" > <attributes> <attribute attributeId="20" valueId="199" /> </attributes> </level> </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. Esse 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) | |||
elemento de nível
| |||
Nome da etiqueta
| level | ||
Descrição
| Especifica um nível a ser atualizado. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
ID | S | A ID do nível a ser atualizado. | 34 |
nome | S | O nome do nível. O nome deve ser exclusivo.
| Nome do novo nível |
shortName | N | O nome curto do nível. | NewLvName |
proceedWithWarnings | N | Indica se o usuário quer ignorar as mensagens de aviso e prosseguir com a operação de criação. 0 para não, 1 para sim. Se houver avisos e continueWithWarnings=0, o nível não será criado. Defina continueWithWarnings=1 para criar o nível quando houver avisos. | 1 |
Conteúdo do elemento
| |||
Um elemento de atributos opcionais se você quiser definir um ou mais atributos de nível associados ao nível. | |||
elemento de atributos
| |||
Nome da etiqueta
| atributos | ||
Descrição
| Contêiner para um ou mais elementos de atributo de nível. | ||
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 um nível. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
attributeID | S | A ID do atributo de nível gerada pelo sistema. | 20 |
valueID | S | A ID exclusiva do valor de atributo de nível gerado pelo sistema.
Defina valueID="" para remover essa marcação de atributo. | 170 |
Conteúdo do elemento
| |||
(nenhum) | |||
Formato da resposta
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <levels> <level="41" name="New Level Name" shortName="NewLvlName" currency="USD"> <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" /> </level> </levels> </output> </response>
elemento de saída
| |
Nome da etiqueta
| saída |
Atributos do elemento
| |
(nenhum) | |
Conteúdo do elemento
| |
Um único elemento de nível obrigatório. 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 níveis
| |||
Nome da etiqueta
| níveis | ||
Descrição
| Contêiner para um ou mais elementos de nível. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
Conteúdo do elemento
| |||
Um ou mais elementos de nível. Se a solicitação incluir níveis inacessíveis, haverá apenas um elemento de nível, que representa o nível superior da organização. | |||
elemento de nível
| |||
Nome da etiqueta
| level | ||
Descrição
| Representa um único nível da organização que está sendo retornado em resposta a uma chamada à API exportLevels. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
ID | S | O número de ID do sistema interno para o nível. | 7 |
nome | S | O nome do nível, como aparece em relatórios e planilhas. | Desenvolvimento |
moeda | S | O código da moeda atribuída a este nível da organização. A moeda será uma das moedas configuradas para a instância, encontradas na chamada exportActiveCurrencies. | INR |
shortName | N | A abreviação do nível, se houver, conforme inserida em Administração da organização. | Dev |
AvailableStart | N | A data de início da disponibilidade do nível para a versão de valores reais, aplicável somente quando a versão de valores reais é especificada na solicitação. O valor pode ser um código de período, como "01/2012" ou o valor especial "START" que indica o início da versão. | 01/2012 |
AvailableEnd | N | A data de término da disponibilidade do nível para a versão de valores reais, aplicável somente quando a versão de valores reais é especificada na solicitação. O valor pode ser um código de período, como "12/2013" ou o valor especial "END" que indica o fim da versão. | 12/2013 |
isImportable | N | Indica se o nível associado pode ser importado na versão especificada. '0' significa que não é importável e '1' significa que é importável. Um nível é importável se pelo menos um intervalo de tempo na versão especificada é importável. O atributo isImportable é emitido somente se versionName ou versionID é especificado na solicitação. isImportable indica apenas que um nível está disponível para importação na versão especificada, não que o usuário que faz a chamada à API tem permissão para importar para a versão ou o nível. Use exportVersions para ver quais versões estão disponíveis para importação pelo usuário. | 1 |
workflowStatus | N | Emite o status do fluxo de trabalho para o nível associado. I para "Em andamento", S para "Enviado", R para "Rejeitado", A para "Aprovado" e L para "Bloqueado". Incluído na resposta somente se o fluxo de trabalho estiver habilitado para esta empresa e um versionName ou versionID do Planning for especificado na solicitação. O fluxo de trabalho não está disponível em versões de valores reais. | I |
isLinked | S | Indica se o nível é um nível vinculado. 0 para não, 1 para sim. | 1 |
isElimination | S | Indica se o nível é um nível de eliminação. 0 para não, 1 para sim. | 0 |
Conteúdo do elemento
| |||
Um elemento de nível aninhado para cada nível filho direto deste nível. Um elemento de atributos se esse nível tem um ou mais atributos associados a ele. | |||
elemento de atributos
| |||
Nome da etiqueta
| atributos | ||
Descrição
| Contêiner para um ou mais elementos de atributo. | ||
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
| Representa um único mapeamento de atributos de nível não em branco ao qual um nível está associado. | ||
Atributos do elemento
| |||
Nome do atributo
| Obrigatório?
| Valor
| Exemplo
|
nome | S | O nome do atributo de nível | Desconto corporativo |
valor | S | O valor do atributo de nível associado ao nível. | Sim |
attributeID | S | O número de ID do sistema interno do atributo de nível. | 20 |
valueID | S | O número de ID do sistema interno do valor do atributo de nível. | 188 |
Conteúdo do elemento
| |||
(nenhum) | |||