Ir para o conteúdo principal
Adaptive Planning
Última atualização: 2023-06-23
exportConfigurableModelData

exportConfigurableModelData

Com suporte na API v19 +
Atualizado na API v35 (18 de novembro de 2022).
Categoria
Recuperação de dados
Descrição
Retorna um conjunto de linhas da planilha modelada solicitada na versão e instância solicitadas.
Permissões obrigatórias para invocar
Acesso de leitura à planilha, versão e instância que está sendo solicitada.
Parâmetros obrigatórios na solicitação
Credenciais, planilha modelada, versão, cargo
Você pode transmitir dados de exportConfigurableModelData para obter melhor desempenho e restrições reduzidas no número de células e linhas que podem ser exportadas. Para transmitir dados, você deve:
  • Usar a API v32 ou superior.
  • Set isGetAllRows=true.
A solicitação desse método contém os parâmetros que serão usados para determinar quais linhas modeladas serão retornadas. O usuário deve ter acesso de leitura à planilha, à versão e à instância que contém a planilha modelada.
Prática recomendada: invoque exportSheet para recuperar o nome e a ID da planilha modelada necessários para sua solicitação exportConfigurableModelData.

Formato da solicitação

Chamada de streaming para recuperar todas as linhas de uma planilha modelada:
<?xml version='1.0' encoding='UTF-8'?> <call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" isGetAllRows="true" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters> </call>
Chamada paginada e sem fluxo contínuo:
<?xml version='1.0' encoding='UTF-8'?> <call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <job jobNumber="0" pageNumber="1"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters> </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
Conteúdo do elemento
(nenhum)
elemento de versão
Nome da etiqueta
versão
Descrição
Especifica de qual versão as linhas modeladas devem ser recuperadas.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Nome
S
O nome da versão.
Orçamento 2
Conteúdo do elemento
Contém um ou mais elementos de nível.
elemento de planilha modelada
Nome da etiqueta
modeled-sheet
Descrição
Especifica de qual planilha modelada as linhas modeladas devem ser recuperadas. Usa a ID ou o nome da planilha de modelo como identificador.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Nome
S
O nome da planilha modelada.
Orçamento de trabalho
isGlobal
N
Especifica se a planilha é atribuída a usuário ou a nível. Se verdadeira, a planilha é uma planilha atribuída a usuário. Se for falso, a planilha é uma planilha atribuída a nível.
false
isGetAllRows
Com suporte na API v32+
N
Especifica se a resposta recupera todas as linhas da planilha. Se verdadeira, todas as linhas retornam sem paginação, o elemento <Levels> se torna opcional e o elemento <Job> não tem suporte na solicitação. Deve ser verdadeiro para oferecer suporte a dados de streaming.
verdadeiro
includeAllColumns
Com suporte na API v22+
N
Especifica se todas as colunas devem ser incluídas na resposta. Qualquer valor diferente de verdadeiro resultará como falso.
false
useNumericIDs
Com suporte na API v22+
N
Especifica se as IDs internas na resposta devem estar em formato numérico. Por exemplo, "
100
" vs "
S100
". Se estiver ausente ou definida como algo diferente de "
true
" (não diferencia maiúsculas de minúsculas), resulta em
false
.
Exemplo de ID de divisão quando
true
:
  • 271
Exemplo de ID de divisão quando
false
:
  • S271
verdadeiro
displayNameEnabled
Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.
N
displayNameEnabled=true indica que exportConfigurableModelData 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 exportConfigurableModelData 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 exportConfigurableModelData ignora as propriedades
code
,
displayNameType
e
description
.
O valor por padrão para displayNameEnabled é "falso".
false
includeCodes
Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.
Essa opção é significativa somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA.
Defina como "true" para incluir a coluna de código do nível e cada dimensão na resposta da API.
Defina como "falso" para excluir a coluna de código do nível e cada dimensão na resposta da API.
O valor por padrão é falso.
false
includeNames
Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.
Essa opção é significativa somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA.
Defina como "true" para incluir a coluna de nome do nível e cada dimensão na resposta da API.
Defina como "falso" para excluir a coluna de nome do nível e cada dimensão na resposta da API.
O valor por padrão é falso.
false
includeDisplayNames
Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.
Essa opção é significativa somente quando a configuração de habilitação efetiva do nome de exibição está ATIVADA.
Defina como "true" para incluir a coluna de nome de exibição para o nível e cada dimensão na resposta da API.
Defina como "falso" para excluir a coluna de nome de exibição do nível e de cada dimensão na resposta da API.
O valor por padrão é falso.
false
useAccountPrecision
Disponível somente na API v33+
N
Essa opção é significativa somente quando isGetAllRows="true"
Defina como "true" para gerar colunas de números com a precisão da conta.
Defina como "false" para gerar colunas de número com a precisão por padrão quando isGetAllRows="true", que é uma precisão de 9.
O valor por padrão é falso.
false
useActualValue
Disponível somente na API v35+
N
Essa opção é significativa somente quando isGetAllRows = "true".
  • Defina como "true" para gerar colunas de números com o valor real.
    • Para colunas numéricas editáveis, serão os dados brutos.
    • Para colunas numéricas calculadas, será o valor calculado até uma precisão de 9.
  • Defina como "false" para gerar colunas de número com a precisão por padrão quando isGetAllRows="true", que é uma precisão de 9.
O valor por padrão é falso.
verdadeiro
Conteúdo do elemento
(nenhum)
elemento de cargo
Nome da etiqueta
job
Descrição
Especifica o número de série do manipulador de API para a tarefa de chamada de API. Este elemento não tem suporte quando isGetAllRows é verdadeiro.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
jobNumber
S
0 para a chamada inicial. Um número de cargo retorna na resposta. Use esse número de tarefa para todas as solicitações subsequentes.
O manipulador de API cria um modelo de planilha que carrega a planilha na memória. A planilha permanece na memória até que a solicitação expire e seja coletada como lixo. A API então retorna a primeira página junto com os outros parâmetros listados acima.
2
pageSize
N
Substitui o pageSize por padrão para permitir que o usuário da API especifique quantas linhas por página são recuperadas em cada chamada. Só entra em vigor na primeira chamada, quando jobNumber="0".
O pageSize é ignorado e todos os dados são retornados na primeira página nos seguintes casos:
  • Se o pageSize fornecido é maior que o número de linhas na planilha.
  • Se o número de células na planilha é menor ou igual a 20.000.
  • Se o número de linhas na planilha é menor ou igual a 500.
200
pageNumber
S
Especifica o número da página que está sendo solicitada se houver mais de uma página. O índice de números de página começa com "1".
O manipulador de API é para o mesmo usuário que faz a chamada subsequente usando a mesma API de solicitação e autenticação.
A solicitação subsequente deve ser feita em até 3 minutos após o tempo da última resposta.
1
Conteúdo do elemento
(nenhum)
elemento de filtros
Nome da etiqueta
filtros
Descrição
Contêiner para todos os elementos relacionados a filtros.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Conteúdo do elemento
Os elementos de níveis e colunas.
elemento de níveis
Nome da etiqueta
níveis
Descrição
Contêiner para um elemento de nível Especifica o nível do qual recuperar as linhas. Esse elemento é opcional quando isGetAllRows é verdadeiro.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Conteúdo do elemento
Elementos de um nível
elemento de nível
Nome da etiqueta
level
Descrição
Especifica um nível pelo qual filtrar a solicitação.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
nome
S
O nome do nível que está sendo solicitado.
O nome só tem suporte para solicitações anteriores à versão 30 quando a habilitação efetiva das configurações de nome de exibição está DESATIVADA.
SEDE
includeDescendants
N
Indica se a exportação deve incluir todos os descendentes do nível especificado ou não. Se definida como verdadeira, todos os filhos deste nível serão exportados, assim como seus filhos e assim por diante. Se definido como falso, este nível será exportado sozinho.
A indicação "falso" permite exportar os níveis indicados como nível (somente) no
Adaptive Planning
interface de usuário da Web
verdadeiro
código
Disponível somente na API v31+ para instâncias que habilitam o nome de exibição.
N
O código do nível a ser exportado. Esse código é conforme especificado em Administração de nível. O atributo de código foi adicionado na API v31.
Use o atributo de nome para solicitações de API anteriores à versão 30 e quando a configuração de habilitação efetiva do nome de exibição estiver DESATIVADA.
false
Conteúdo do elemento
O nome do nível
elemento de colunas
Nome da etiqueta
colunas
Descrição
Contêiner para dois elementos: modelo e sistema. As etiquetas de modelo e de sistema, por sua vez, têm elementos de coluna filho que especificam o nome da coluna.
Disponível somente na API v33+
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Conteúdo do elemento
Um elemento de modelo
elemento de modelo
Nome da etiqueta
modelo
Descrição
Especifica um conjunto de colunas de planilha modelada. Contém elementos de coluna filho.
Disponível somente na API v33+
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Conteúdo do elemento
Contém elementos "colunas" filho. Para colunas de modelo, quando especificarmos o elemento de período temporal, usaremos o nome "Período temporal".
elemento do sistema
Nome da etiqueta
sistema
Descrição
Especifica um conjunto de nomes de colunas do sistema. As opções permitidas são "InternalID", "ParentID" e "IsParent".
Disponível somente na API v33+
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Conteúdo do elemento
Contém elementos "colunas" filho.
elemento de coluna
Nome da etiqueta
coluna
Descrição
Especifica um nome de coluna da planilha modelada. Os valores especiais incluem os nomes das colunas do sistema listados acima e, para as colunas do modelo, é o nome da coluna "Período temporal".
Disponível somente na API v33+
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Conteúdo do elemento
Um elemento de modelo
Exemplo de colunas
<columns> <model> <column>NumberCurrency</column> <column>Regional Code</column> <column>CountryRegion</column> <column>CalcAcctNum</column> <column>Level Currency</column> <column>Invalid Column Name</column> <column>InitialBalance</column> <column>Timespan</column> </model> <system> <column>InternalID</column> <column>Invalid System Column Name</column> <column>IsParent</column> <column>ParentID</column> </system> </columns
Elemento timeSpan
Nome da etiqueta
timeSpan
Descrição
Se a planilha de modelo tem um elemento timeSpan, o início e o fim especificam o intervalo de tempo dos dados a serem exportados da planilha. Se timeSpan não é incluído, os dados do intervalo de datas completo da versão são exportados. Usar um código de período interno (consulte Alterar estrutura de calendário) ou rótulo de tempo localizado na visualização da planilha para indicar um início ou término de timeSpan.
TimeSpan duplica a funcionalidade de Opções de exibição > Configurações de tempo para seleções de tempo folha em Início e Fim para uma planilha modelada no
Adaptive Planning
UI
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
início
N
O código de entrada de horas ou o rótulo de hora localizado visível na planilha do primeiro período no intervalo a ser exportado. O período de início deve ser um período folha. Se o início não é indicado, o início da versão é usado.
Jan-2016
01/2016
fim
N
O código de entrada de horas ou o rótulo de hora localizado do último período no intervalo a ser exportado. O período de término deve ser um período folha. Se o fim não é indicado, o fim da versão é usado.
Nov-2016
11/2016

Exemplos de timeSpan

Início em janeiro de 2016 e término em abril de 2016. Jan-2016 é o código de período temporal interno indicado pela UI de administração de tempo. 04/2016 é um rótulo de tempo na planilha.
<timeSpan start="Jan-2016 end="04/2016"/>
Início em fevereiro de 2016 e término na data de término da versão. 02/2016 é um rótulo de tempo da planilha.
<timeSpan start="02/2016"/>
Comece com a data de início da versão e termine em novembro de 2016. Nov-2016 é o código de período interno indicado pela UI de administração de tempo.
<timeSpan start="" end="Nov-2016"/>

Formato da resposta

<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data jobNumber="3"> <![CDATA["InternalID","Plan","CapitalAssetClass","Label","Price","Currency","Mar-2016","Q1-FY16","Apr-2016","May-2016","Jun-2016","Q2-FY16","Jul-2016","Aug-2016","Sep-2016","Q3-FY16","Oct-2016","Nov-2016","Dec-2016","Q4-FY16","FY2016","Jan-2017","Feb-2017","Mar-2017","Q1-FY17","Apr-2017","May-2017","Jun-2017","Q2-FY17","Jul-2017","Aug-2017","Sep-2017","Q3-FY17","Oct-2017","Nov-2017","Dec-2017","Q4-FY17","FY2017" "S1325","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1326","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1327","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1328","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1323","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S1324","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output> </response>
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
Conteúdo do elemento
Um único elemento de mensagens opcional e exatamente um elemento de saída obrigatório.
elemento de mensagens
Nome da etiqueta
mensagens
Descrição
Contêiner para um ou mais elementos de mensagem.
Atributos do elemento
(nenhum)
Conteúdo do elemento
Um ou mais elementos de mensagem.
elemento de mensagem
Nome da etiqueta
mensagem
Descrição
Representa uma mensagem que está sendo enviada pelo sistema de volta para o autor da chamada. As mensagens são usadas para mensagens de erro quando as solicitações não são bem-sucedidas, para mensagens de aviso quando as solicitações são bem-sucedidas e para mensagens de confirmação quando as solicitações são bem-sucedidas.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
chave
N
Quando fornecida, uma chave é uma forma de identificar uma determinada mensagem ou tipo de mensagem, útil para fins de registro automatizado de erros e recuperação em programas cliente. As chaves não são alteradas em diferentes parâmetros regionais de solicitações, mesmo quando o idioma da mensagem é alterado. As chaves também não devem ser alteradas no futuro devido a ajustes de texto ou alterações de terminologia.
invalid-attributevalueid
Conteúdo do elemento
O texto da mensagem. Esse texto está no idioma dos parâmetros regionais especificados na solicitação (supondo que haja suporte para os parâmetros regionais). O texto também pode conter informações variáveis, como o número de linhas que foram processadas ou a coluna ou valor específico que causou um erro.
Para a versão de streaming da API (isGetAllRows="true"): quando a API falha durante o streaming de linhas, fechamos as etiquetas xml e adicionamos uma mensagem:
Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.
elemento de cargo
Nome da etiqueta
job
Descrição
Especifica a tarefa e as informações de paginação de dados para os dados retornados para que o usuário possa fazer uma série de chamadas para extrair todos os dados do conjunto de dados filtrado da planilha de modelo.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
jobNumber
N
O número de série do manipulador de API dedicado atribuído pelo servidor para a tarefa de chamada de API. Usado em todas as solicitações subsequentes.
2
numberOfPages
N
O número total de páginas de dados disponíveis para o conjunto de filtros.
3
pageNumber
N
O número da página do conjunto de dados atual que está sendo retornado.
1
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 saída
Nome da etiqueta
saída
Descrição
A etiqueta de saída tem um elemento filho, a etiqueta de dados.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
Nível
N
O nome do nível em que esta linha ou divisão/linha reside. Isso aparece independentemente de o nível que está sendo solicitado ser um nível de consolidação ou não.
Engenharia
Conteúdo do elemento
Um único elemento de dados
Nome da etiqueta
dados
Descrição
A resposta retorna um bloco CDATA contendo um despejo de dados no formato CSV das linhas modeladas que estão sendo exportadas. A primeira linha do bloco CDATA é a "linha de cabeçalho" do CSV, e todas as linhas seguintes são linhas de dados. Se nenhuma linha corresponde à solicitação de filtragem, somente a linha de cabeçalho é gerada.
As colunas do CSV começam com até cinco colunas com foco interno codificadas. Essas colunas podem identificar a linha e algumas de suas propriedades imutáveis. As colunas presentes na planilha são as seguintes, independentemente de:
  • O usuário individual pode tê-los ocultado em suas opções de exibição
  • As colunas são somente leitura ou não.
Todas as colunas na resposta da API são visíveis/definidas para a planilha, com o cabeçalho de coluna declarado sendo o rótulo na linha de cabeçalho. Isso inclui todas as colunas de atributos inseridas na planilha. Para a conta de período temporal, os cabeçalhos das colunas são os meses da versão atual no mesmo formato da API exportData .
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
totalRowCount
Disponível na API v35+ quando isGetAllRows=true.
N
Esse atributo é adicionado ao elemento de dados para a versão de streaming da API. Indica o número total de linhas que a planilha modelada espera exportar.
"10"
Conteúdo do elemento
Um bloco CDATA contendo:
  • Linhas formatadas como CSV válido.
    • As cadeias de caracteres são colocadas entre aspas duplas.
    • Os números são emitidos no
      formato canônico
      (não no formato que diferencia parâmetros regionais). As vírgulas foram removidas
    • Dimensões e seletores de texto emitem o valor selecionado que eles têm. Se não têm valor, emitem uma cadeia de caracteres vazia.
  • Ao emitir linhas pai, todas as colunas que podem ser divididas são mostradas como
    em branco
    no CSV (elas não tentam mostrar nenhum valor consolidado ou "vários" valores).
  • Quando linhas filho/divididas são emitidas, todas as colunas
    não divisíveis
    são mostradas como contendo o valor da linha pai. É idêntico ao comportamento da planilha na interface de usuário da Web do Adaptive Planning.
Um elemento de status
Nome da etiqueta
status
Descrição
Disponível somente na API v35+ quando os dados são transmitidos (isGetAllRows="true").
A etiqueta de status é adicionada após a etiqueta de saída para os casos de êxito e falha da versão de streaming da API.
Atributos do elemento
Nome do atributo
Obrigatório?
Valor
Exemplo
êxito
S
Se todos os dados foram transmitidos, ele retorna êxito = "true" e, se houver um erro (devido a validações ou falhas antes de todas as linhas serem transmitidas), retorna êxito = "falso".
verdadeiro
rowCountSent
N
O número ou linhas que foram enviadas. Se for uma resposta com falha, esse número não corresponderá ao valor de totalRowCount definido no elemento de dados.
1
Conteúdo do elemento
(nenhum)

Remoção do "S" de parentId quando useNumericIds = "true" para a versão de streaming da API (isGetAllRows=true)

A partir da versão 35 da API, parentId não conterá o prefixo "S" em seu valor.

Valor de escape de "in" para a versão de streaming da API (isGetAllRows=true)

A partir da versão 35 da API, qualquer valor de coluna que tenha um " terá um escape no formato de estilo CSV (portanto, " será representado por "").

Como lidar com cenário de falha durante a transmissão

Quando a API falha durante o streaming das linhas, fechamos as etiquetas xml e enviamos uma mensagem de erro.
Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.
Exemplo de resposta
:
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data> <![CDATA["InternalID","Level","Plan","CapitalAssetClass","Label","Price","Currency","Jan-2010","Feb-2010","Mar-2010","Q1-FY10","Apr-2010","May-2010","Jun-2010","Q2-FY10","Jul-2010","Aug-2010","Sep-2010","Q3-FY10","Oct-2010","Nov-2010","Dec-2010","Q4-FY10","FY2010","Jan-2011","Feb-2011","Mar-2011","Q1-FY11","Apr-2011","May-2011","Jun-2011","Q2-FY11","Jul-2011","Aug-2011","Sep-2011","Q3-FY11","Oct-2011","Nov-2011","Dec-2011","Q4-FY11","FY2011","Jan-2012","Feb-2012","Mar-2012","Q1-FY12","Apr-2012","May-2012","Jun-2012","Q2-FY12","Jul-2012","Aug-2012","Sep-2012","Q3-FY12","Oct-2012","Nov-2012","Dec-2012","Q4-FY12","FY2012","Jan-2013","Feb-2013","Mar-2013","Q1-FY13","Apr-2013","May-2013","Jun-2013","Q2-FY13","Jul-2013","Aug-2013","Sep-2013","Q3-FY13","Oct-2013","Nov-2013","Dec-2013","Q4-FY13","FY2013","Jan-2014","Feb-2014","Mar-2014","Q1-FY14","Apr-2014","May-2014","Jun-2014","Q2-FY14","Jul-2014","Aug-2014","Sep-2014","Q3-FY14","Oct-2014","Nov-2014","Dec-2014","Q4-FY14","FY2014" "S289","HQ","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S290","HQ","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S291","HQ","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S292","HQ","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S287","HQ","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","" "S288","HQ","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output> <messages> <message>Exporting configurable model data failed. Retry the export. Contact Support if the export continues to fail.</message> </messages> </response>

Exemplo de resposta com API de status v35 com streaming (isGetAllRows="true")

<?xml version="1.0" encoding="UTF-8"?> <response> <output> <data totalRowCount="6"> <![CDATA["InternalID","CapitalAssetClass","Price" "S289","Furniture","90" "S290","Furniture","200" "S291","Computers","2500" "S292","Computers","1000" "S287","Facility","" "S288","OtherEquipment",""]]> </data> </output> <status success="true" rowCountSent="6"></status> <messages> <message>System Column names [Invalid System Column Name] specified in the request weren't found and will be ignored.</message> <message>Model Column names [timespan,invalid column name] specified in the request weren't found and will be ignored.</message> </messages> </response>

Mensagem de aviso para nomes de coluna inválidos

Quando um nome de coluna inválido é especificado na solicitação, enviamos mensagens.
Exemplo de resposta
:
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <data> <![CDATA["InternalID","CapitalAssetClass","Price" "S289","Furniture","90" "S290","Furniture","200" "S291","Computers","2500" "S292","Computers","1000" "S287","Facility","" "S288","OtherEquipment",""]]> </data> </output> <messages> <message>System Column names [Invalid System Column Name] specified in the request weren't found and will be ignored.</message> <message>Model Column names [timespan,invalid column name] specified in the request weren't found and will be ignored.</message> </messages> </response>