Compartilhar via


NextGen do QPP (versão prévia)

O QPP (Quark Publishing Platform) NextGen é um CCMS (sistema de gerenciamento de conteúdo de componentes) baseado em nuvem para automatizar a publicação de conteúdo corporativo altamente regulamentado. O conector do QPP NextGen ajuda a mover dados de seu ecossistema de conteúdo em ambas as direções para simplificar processos e acelerar o tempo para o mercado.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte técnico do Quark
URL https://quarksoftware.my.site.com
Email support_cases@quark.com
Metadados do conector
Publicador Quark Software Inc.
Site https://www.quark.com/
Política de privacidade https://www.quark.com/privacy-policy
Categorias Conteúdo e arquivos; Produtividade

O QPP (Quark Publishing Platform) NextGen é um CCMS (sistema de gerenciamento de conteúdo de componentes) baseado em nuvem para automatizar a publicação de conteúdo corporativo altamente regulamentado. O conector do QPP NextGen ajuda a mover dados de seu ecossistema de conteúdo em ambas as direções para simplificar processos e acelerar o tempo para o mercado.

Pré-requisitos

  • Você precisa de um ambiente QPP-NG (v3.3 acima) e licenças QPP-NG para usar nosso Conector.
  • Você precisa ter um cliente existente (Connection), preferencialmente separado, criado nos locatários para os quais eles desejam que as ações e gatilhos desse conector interajam. Mais detalhes podem ser encontrados na seção Obtendo Credenciais.
  • Entenda como usar o power automate e obter valor usando conteúdo dinâmico ou de outras ações de resposta usando o criador de consulta.

Como obter credenciais

Ao criar uma nova conexão com nosso conector, você verá três params. Os detalhes para adquirir cada um deles são compartilhados abaixo. Criando e criando uma nova conexão com nosso conector, os usuários verão três params. Os detalhes para adquirir cada um deles são compartilhados abaixo. A criação e o gerenciamento de conexões de QPP-NG devem ser feitos pelo usuário administrador. Verifique com o administrador de ambientes QPP-NG.

Você também pode nomear suas credenciais adequadamente para identificá-las facilmente mais tarde. Vá para Conexões no Power Automate, pesquise o nome do conector e edite uma conexão existente e forneça um nome apropriado.

  • ID do cliente: Você pode navegar até o aplicativo administrador de locatários QPP-NG desejado e, em seguida, configurações > de conexões. Aqui, eles podem criar uma nova conexão ou usar uma existente. Basta inserir o nome da conexão para a ID do cliente.
  • Segredo do cliente: Assim como a ID do Cliente, navegue até Conexões e insiraSegredo para a conexão existente. Regenerar o segredo se você não o tiver. Os segredos devem ser armazenados para conexões existentes com segurança, gerenciados pelo administrador. Verifique com o administrador antes de regenerar o segredo.
  • Nome do host: O nome do host do locatário QPP-NG que você deseja criar conexões para interagir com nosso conector. exemplo (yourtenantname.app.quark.com). Deve estar visível na URL quando você acessar seu ambiente de QPP-NG.

Depois de criar Credenciais, você pode testar as credenciais para ver se as credenciais estão corretas.

Ações simples como getUser podem ser usadas em nosso conector em um fluxo manual, teste o fluxo com campos padrão.

Ao criar uma conexão pela primeira vez, alguns códigos de erro que podem ser enfrentados são os seguintes:

  • URL de host inválida (500): Verifique o nome do host para o ambiente QPP-NG novamente, a ID do cliente e o segredo devem pertencer a essa conexão.
  • Não autorizado/unauthorized_client (401): Para credenciais de cliente inválidas ou inválidas, verifique se a ID do cliente e o segredo do cliente são válidos e pertencem ao nome do host que está sendo usado.

Introdução ao QPP-NG Integration Hub

Para começar, você pode ouvir uma ampla variedade de eventos de Type Asset, Collections etc. de seu locatário QPP-NG usando Gatilho interno.

  • Crie um novo fluxo de Automação no Power Automate.
  • Selecione nosso conector QPP-NG e escolha um gatilho.
  • Preencha os campos necessários. Consulte a seção Webhook-trigger na documentação do Github Readme.
  • Selecione a Conexão apropriada para o locatário QPP-NG em que você deseja registrar o webhook. Você também pode criar novas conexões. Siga as etapas fornecidas na seção Como obter credenciais .
  • Salve o fluxo. Isso executará a solicitação de registro na parte de trás. Ao retornar à página de detalhes do fluxo (ou clicar no botão Voltar), você deverá ver um sublinhado verde na parte superior mencionando que tudo correu bem e que o fluxo está pronto para ser disparado.
  • Depois que o fluxo for executado uma vez, você poderá obter ainda mais a resposta do webhook para a execução do fluxo e usar a resposta para gerar conteúdo dinâmico. Para isso, você pode usar a ação analisar json OOTB.
  • Caso este seja o primeiro webhook com esse tipo de alteração (evento) registrado no locatário QPP-NG, você precisará aguardar 15 minutos antes que o webhook seja ativado e, em seguida, você pode esperar que o fluxo seja disparado.

Se houver erros no verificador de fluxo com o gatilho de webhook, o Power Automate mostrará vermelho no verificador de fluxo. Abra-o e verifique o erro. Abaixo estão alguns dos erros que você pode encontrar e as etapas para atenuá-los.

  • Webhook com nome já existe Forneça um nome exclusivo para o webhook ou use a operação Excluir Webhook com a mesma conexão em outro fluxo manual. Selecione o webhook com o mesmo nome e exclua-o. Mais informações sobre Webhooks podem ser encontradas no portal do Desenvolvedor do Quark.
  • Solicitação incorreta(400) Verifique os Parâmetros fornecidos de acordo com a documentação e os detalhes do erro.
  • Recurso não encontrado (404) & Cabeçalho de localização está ausente na solicitação de assinatura Exclua o fluxo e crie um novo gatilho e fluxo de webhook. Se o fluxo for grande, duplicar o fluxo e, ao habilitar o fluxo e salvar, o Power Automate tentará fazer um novo registro de webhook.

Problemas e limitações conhecidos

  • Atualmente, você não poderá atualizar os parâmetros para um gatilho de webhook já registrado. Como solução alternativa, exclua a operação de webhook atual do fluxo e adicione um novo gatilho de webhook QPP-NG em seu lugar. Para excluir o webhook registrado anteriormente do ambiente de QPP-NG, crie um novo fluxo manual com a operação de exclusão, selecione o webhook anterior na lista suspensa e execute o fluxo. Se essa solução alternativa não funcionar e o fluxo for grande, duplicar o fluxo e, depois de atualizar os detalhes do webhook, salve e habilite-o. Isso também criará um novo registro de webhook com êxito.
  • Você também pode desativar o fluxo antes de excluir e criar um novo Gatilho. Isso também garantirá que seu novo webhook será registrado.
  • Se o serviço de webhook QPP-NG não puder invocar o webhook-trigger registrado por 3 vezes, o webhook será desabilitado.
  • Salvar determinadas ações sem parâmetros fornecidos (vazio) fornece um erro (espere algum valor no corpo).
  • Se este for o primeiro webhook com esse tipo de alteração (evento), você precisará aguardar 15 minutos antes que o webhook seja ativado e, em seguida, você pode esperar que o fluxo seja disparado.
  • Use a exibição de designer herdado para obter a melhor experiência, pois pode haver problemas com o novo designer devido ao desenvolvimento contínuo, tais ações com problemas com o novo designer são CheckOut, SetAttributeValues, InitNewCheckin &CreateQuery.

Erros e soluções comuns

  • Ao registrar o Gatilho de Webhooks como uma primeira etapa, pode haver um problema no registro com nosso serviço se os detalhes não forem fornecidos corretamente. Isso pode ser reduzido depois de salvar o fluxo com o gatilho e retornar à janela da página Detalhes do Fluxo, na qual as execuções dos últimos 28 dias são mostradas. Se ele mostrar vermelho, isso significa que o webhook não foi registrado corretamente. Verifique o erro. Se o erro ocorrer devido ao cabeçalho Local estar ausente ou o recurso não estiver sendo encontrado, tente excluir e criar o gatilho novamente.
  • Se os fluxos não estiverem sendo disparados, isso pode ser devido a um webhook existente registrado como um ponto de extremidade que não existe, como um fluxo excluído etc. Em tal situação, execute a API https://{Host.name}/webhooks/api/v3/registrations com seu token de API para obter uma lista de todos os webhooks registrados no ambiente QPP-NG e use essa resposta para remover esses webhooks usando a ação excluir webhooks. Você também precisa garantir que o serviço de webhooks esteja configurado corretamente e em execução do seu suporte do Quark usando (https://quarksoftware.my.site.com).
  • Se você não receber um usuário privilegiado ou qualquer erro de autenticação, verifique se o nome de usuário fornecido para Representação tem privilégios suficientes em seu locatário QPP-NG,
  • No caso de problemas específicos da ação, consulte exemplos e documentação compartilhadas no repositório de software livre no Github no arquivo Readme.md ou consulte o portal do Desenvolvedor do Quark para obter mais informações sobre pontos de extremidade e funcionalidade.

Perguntas frequentes

Posso usar as ações e gatilhos com ambientes de QPP-NG diferentes?

Sim, é possível. Você só precisa preencher o parâmetro Nome do Host de acordo com o ambiente e usar conexões apropriadas para esse ambiente.

Você pode nos ajudar se ficarmos presos em algo ou tiver dúvidas?

Com certeza. Basta enviar um email [email protegido] (https://quarksoftware.my.site.com) e certifique-se de mencionar o Conector do Microsoft Power Automate ao descrever o problema.

Onde posso obter mais informações sobre as ações e pontos de extremidade?

Mais informações sobre as várias APIs do Quark podem ser encontradas aqui. Basta navegar até a guia Plataforma de Conteúdo. Como esse conector contém apenas um subconjunto da API real possível para a plataforma QPP-NG, esse site pode ser usado para explorar e solicitar mais ações e pontos de extremidade por meio do registro em log de uma solicitação de recurso em [email protegido].

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:

Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
ID do cliente (clientId) cadeia Especifique a ID do cliente de suas credenciais de serviço. Verdade
Segredo do cliente (clientSecret) secureString Especifique o Segredo do Cliente de suas credenciais de serviço. Verdade
Nome do host cadeia Especificar o nome do host Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar mapeamento de atributo para tipo de conteúdo

Atualize o mapeamento de atributos de tipos de conteúdo e filhos com o mapa de atributo especificado no corpo da solicitação. Consulte os documentos do GitHub para obter detalhes.

Baixar (Blob)

Essa solicitação é usada para baixar o arquivo por fluxo de entrada da URL de download. Consulte os documentos do GitHub para obter detalhes.

Caixa

Marca o ativo com a assetId fornecida como Check-out. Consulte os documentos do Github para obter detalhes.

Carregar (Blob)

Essa solicitação é usada para carregar o arquivo por fluxo de entrada. Consulte os documentos do GitHub para obter detalhes.

Cria um novo atributo

Cria um novo atributo e retorna sua ID juntamente com uma mensagem de sucesso. Consulte os documentos do GitHub para obter detalhes.

Cria um novo atributo list

Cria um novo atributo e retorna sua ID após a criação bem-sucedida da mensagem de atributo. Para obter mais informações, verifique a documentação do github.

Criar consulta

Crie uma consulta com definição e detalhes no corpo da solicitação. Consulte os documentos do GitHub para obter detalhes.

Definir valores de atributo

Defina valores de atributo para a Plataforma QPP. Para obter mais informações, verifique a documentação do Github.

Exclui o Webhook

Exclui um webhook já existente para um determinado tipo de evento e alteração. Para obter mais informações, verifique a documentação do github.

Iniciar check-in e atualizar

A solicitação fará check-in e atualizará um ativo já existente no QPPNG. O ativo precisa ser feito antes do check-out. Use a ação de check-out antes. Para obter mais informações, verifique a documentação do github.

Iniciar novo check-in

A solicitação fará check-in de um arquivo local, de acordo com a matriz de valores de atributo Qpp, por exemplo, os valores de atributo necessários são nome, coleção, extensão etc. para fazer check-in de um ativo para QPPNG. Para obter mais informações, verifique a documentação do github.

Obter atributos por nome

Retorna todos os atributos existentes com metadados no Servidor QPPNG para nomes especificados. Consulte os documentos do GitHub para obter detalhes.

Obter fluxo de trabalho por nome

Essa solicitação retorna todos os metadados de um fluxo de trabalho especificado por nome. Consulte os documentos do Github para obter detalhes.

Obter grupo por nome

Essa solicitação retornará um grupo específico ao nome do grupo.

Obter grupos para uma coleção

Essa solicitação retorna uma matriz de grupos de roteamentos aplicáveis para a coleção especificada para o fluxo de trabalho e o status especificados. Para obter mais informações, verifique a documentação do github.

Obter informações de download de ativos

A solicitação retornará informações de download de ativos que podem ser usadas junto com a ação Baixar Blob para baixar o fluxo de ativos. Para obter mais informações, verifique a documentação do github.

Obter informações de tipos de conteúdo por nome

Essa solicitação é usada para recuperar informações de tipo de conteúdo pelo nome do tipo de conteúdo. Consulte o Github Docs para obter detalhes.

Obter membros do grupo

Essa solicitação retornará a lista de usuários e todos os metadados específicos à ID do grupo. Consulte os documentos do GitHub para obter detalhes.

Obter metadados de ativos

Obter dados de ativos para determinada ID de ativo. Para obter mais informações, verifique a documentação do Github.

Obter relações de ativo pai

Essa solicitação retornará a lista de relações de uma relação de ativo pai. Consulte os documentos do GitHub para obter detalhes.

Obter relações de ativos filho

Obtenha relações de ativo filho para uma ID de ativo pai. Consulte os documentos do Github para obter detalhes.

Obter resultados da consulta paginada com filtros

Essa solicitação retorna elemento de consulta paginado e detalhes de uma consulta armazenada no sistema com filtro específico na consulta. Para obter mais informações, verifique a documentação do github.

Obter status de publicação

Obtenha o Status de Publicação para um determinado ativo. Consulte os documentos do Github para obter detalhes.

Obter todas as consultas

Essa solicitação retornará toda a consulta com a definição de lá. Consulte os documentos do Github para obter detalhes.

Obter todos os usuários

Essa solicitação é usada para buscar todos os usuários. Consulte os documentos do Github para obter detalhes.

Obter token de acordo com o tipo de concessão

Essa solicitação busca o token para o nome de usuário e a senha fornecidos para QPPNG. Consulte os documentos do GitHub para obter detalhes.

Obter Usuário por ID

Essa solicitação é usada para buscar os metadados de um usuário especificado. Consulte os documentos do GitHub para obter detalhes.

Obter usuário por nome

Essa solicitação retornará metadados do usuário específicos ao nome de usuário. Consulte os documentos do GitHub para obter detalhes.

Obter valores de atributo de IDs

Obter valores de atributo para IDs separadas por vírgulas. Para obter mais informações, verifique a documentação do Github.

Obter valores de atributos por nome

Obtenha valores de atributo para nomes separados por vírgulas. Consulte os documentos do GitHub para obter detalhes.

Publicar Ativo Assíncrono

Retorna a ID de Contexto do ativo que está sendo publicado. Use com o status de Obtenção de Publicação. Consulte os documentos do GitHub para obter detalhes.

É usuário um membro do grupo

Essa solicitação retornará true ou false de que um usuário é membro do grupo específico à userId.

Atualizar mapeamento de atributo para tipo de conteúdo

Atualize o mapeamento de atributos de tipos de conteúdo e filhos com o mapa de atributo especificado no corpo da solicitação. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do atributo
attributeId True integer

IDs de atributo que precisam ser mapeadas.

IDs de tipo de conteúdo
contentTypeIds True string

Tipos de conteúdo nos quais esses atributos precisam ser mapeados.

Baixar (Blob)

Essa solicitação é usada para baixar o arquivo por fluxo de entrada da URL de download. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Token de autenticação
authTokenforHeader True string

Token de autenticação necessário aqui separadamente. A ação TokenFromAuthWrapper pode ser usada aqui para buscar o token.

Identificador de arquivo
fileIdentifier True string

Identificador de Arquivo refere-se ao tipo de arquivo.

ID de contexto
contextId True string

A ID de contexto refere-se às informações do recurso.

Retornos

Nome Caminho Tipo Description
Tipo de conteúdo
$content-type string

O tipo de conteúdo do documento, por exemplo, aplicativo/pdf.

Content
$content byte

O conteúdo do documento na codificação Base64.

Caixa

Marca o ativo com a assetId fornecida como Check-out. Consulte os documentos do Github para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True integer

AssetId variável deve se referir ao ativo do servidor QPP.

ID do atributo
attributeId integer

Identificador do atributo.

Tipo
type integer

Tipo do atributo.

Value
attributeValue object

Valor.

Retornos

Corpo
Asset

Carregar (Blob)

Essa solicitação é usada para carregar o arquivo por fluxo de entrada. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Identificador de arquivo
fileIdentifier True string

Identificador de Arquivo refere-se ao tipo de arquivo.

ID de contexto
contextId True string

A ID de contexto refere-se às informações do recurso.

Recurso de fluxo de entrada
InputStreamResource True

O Fluxo de Entrada para o recurso precisa de entrada binária.

Cria um novo atributo

Cria um novo atributo e retorna sua ID juntamente com uma mensagem de sucesso. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome
name True string

Nome do atributo.

Tipo de Atributo
valueType True integer

Tipo de atributo.

Retornos

Detalhes de um atributo associado a uma entidade.

Cria um novo atributo list

Cria um novo atributo e retorna sua ID após a criação bem-sucedida da mensagem de atributo. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Número de domínios a serem mostrados
_skiptoken True integer

Número de domínios para ignorar a lista suspensa da ID do Domínio.

Nome
name True string

Nome do atributo.

Tipo de Atributo
valueType True integer

Tipo de Atributo, deve ser lista para o tipo de lista.

Valores Múltiplos
multiValued boolean

Indica se o atributo pode conter vários valores.

Acesso limitado
limitedAccess boolean

Aplicável somente para tipo de lista (indica se o atributo tem acesso limitado precisa configurar funções para isso antes).

ID do domínio
domainId integer

ID de domínio associada à lista de fontes de dados/domínio existente. Use o token skip para percorrer 20 itens na lista suspensa.

Retornos

Detalhes de um atributo associado a uma entidade.

Criar consulta

Crie uma consulta com definição e detalhes no corpo da solicitação. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Número de atributos a serem ignoradas
_skiptoken True integer

Número de atributos a serem removidos da lista suspensa de atributos.

Nome da consulta
queryName True string

Nome da consulta.

Parametrizada
parameterized boolean

Indica se a consulta é parametrizada.

ID do atributo
attributeId integer

ID do atributo para Pesquisa.

Tipo de Atributo
type integer

Tipo do Atributo selecionado para condição.

Operador de Comparação
comparisonOperator integer

Operador de comparação para a condição.

Negado
negated boolean

Indica se a condição está negada.

Valor a ser pesquisado em relação a
value string

valor para Pesquisar Contra.

Operador lógico
logicalOperator integer

Operador OR e lógico para a condição.

ID da coluna
columnId True integer

ID da coluna de exibição.

Largura
width True integer

Largura da coluna de exibição.

Coluna de atributo
attributeColumn True boolean

Indica se a coluna é uma coluna de atributo.

Modo de Exibição
displayMode True integer

Configuração do modo de exibição.

Retornos

ID de consulta recém-criada.

ID de consulta recém-criada
integer

Definir valores de atributo

Defina valores de atributo para a Plataforma QPP. Para obter mais informações, verifique a documentação do Github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True string

ID do ativo da plataforma QPP.

ID do atributo
attributeId integer

Identificador do atributo.

Tipo
type integer

Tipo do atributo.

Valores Múltiplos
multiValued boolean

Indica se o atributo tem vários valores.

Value
attributeValue object

Valor.

Exclui o Webhook

Exclui um webhook já existente para um determinado tipo de evento e alteração. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome ou ID
nameOrId True string

Nome ou ID do webhook existente no ambiente.

Retornos

Iniciar check-in e atualizar

A solicitação fará check-in e atualizará um ativo já existente no QPPNG. O ativo precisa ser feito antes do check-out. Use a ação de check-out antes. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Criar versão secundária
createMinorVersion True boolean

A variável createMinorVersion deve se referir a true ou false para criar uma versão para verificação.

ID do ativo
assetId integer

ID do ativo a ser verificado.

Retornos

Iniciar novo check-in

A solicitação fará check-in de um arquivo local, de acordo com a matriz de valores de atributo Qpp, por exemplo, os valores de atributo necessários são nome, coleção, extensão etc. para fazer check-in de um ativo para QPPNG. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Número de atributos/domínios a serem ignoradas
_skiptoken True integer

Número de atributos/domínios a serem ignoradas.

Criar versão secundária
createMinorVersion True boolean

A variável createMinorVersion deve se referir a true ou false para criar uma versão para verificação.

ID do atributo
attributeId integer

ID do atributo.

Tipo de Atributo
type integer

Tipo de atributo.

Valores Múltiplos
multiValued boolean

Indica se o atributo tem vários valores.

ID
id integer

A ID correspondente ao nome, como a ID da coleção Home 1, é obtida.

Nome
name string

Nome do Atributo, como nome do tipo de conteúdo ou nome da coleção.

ID do domínio
domainId integer

ID de domínio associada à lista de fontes de dados/domínio existente. Sua ID para o domínio.

Value
value string

Valor do atributo a ser definido.

ID do valor do domínio
id integer

A ID do próprio Valor de Domínio, por exemplo, A ID de um Valor de Domínio para um Usuário será a ID do usuário, já que a lista de usuários é o Domínio.

Retornos

Obter atributos por nome

Retorna todos os atributos existentes com metadados no Servidor QPPNG para nomes especificados. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nomes de atributo
attributeNames True string

O Nome do Atributo deve se referir ao nome do atributo do servidor QPP (vírgula separada, se múltipla).

Retornos

Obter fluxo de trabalho por nome

Essa solicitação retorna todos os metadados de um fluxo de trabalho especificado por nome. Consulte os documentos do Github para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome do fluxo de trabalho
workflowName True string

Nome do fluxo de trabalho para o qual os metadados precisam ser buscados.

Retornos

Detalhes de um fluxo de trabalho.

Workflow
Workflow

Obter grupo por nome

Essa solicitação retornará um grupo específico ao nome do grupo.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome de Grupo
groupName True string

GroupName variável deve se referir ao nome do grupo de servidores QPP.

Retornos

Corpo
Group

Obter grupos para uma coleção

Essa solicitação retorna uma matriz de grupos de roteamentos aplicáveis para a coleção especificada para o fluxo de trabalho e o status especificados. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID da coleção QPPNG
collectionId True integer

Variable collectionId deve se referir à ID da coleção QPPNG.

Retornos

Obter informações de download de ativos

A solicitação retornará informações de download de ativos que podem ser usadas junto com a ação Baixar Blob para baixar o fluxo de ativos. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True integer

AssetId deve se referir ao ativo do servidor QPP.

Versão Menor
minorVersion integer

A versão secundária deve se referir à versão secundária do Ativo necessária. Forneça 0 para buscar metadados da versão mais recente.

Versão Principal
majorVersion integer

A versão principal deve se referir à versão principal do Ativo necessária. Forneça nulo para buscar metadados da versão mais recente.

Retornos

Obter informações de tipos de conteúdo por nome

Essa solicitação é usada para recuperar informações de tipo de conteúdo pelo nome do tipo de conteúdo. Consulte o Github Docs para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome do tipo de conteúdo
contentTypeName True string

Nome do tipo de conteúdo.

Retornos

Obter membros do grupo

Essa solicitação retornará a lista de usuários e todos os metadados específicos à ID do grupo. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do grupo
groupId True integer

A ID do grupo deve se referir ao Grupo QPPNG.

Retornos

response
array of User

Obter metadados de ativos

Obter dados de ativos para determinada ID de ativo. Para obter mais informações, verifique a documentação do Github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True integer

ID do Ativo na Plataforma QPPNG que está sendo apontada.

Retornos

Corpo
Asset

Obter relações de ativo pai

Essa solicitação retornará a lista de relações de uma relação de ativo pai. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo filho
childAssetId True integer

ChildAssetId variável deve se referir ao ativo filho do servidor QPP que tem relação com o pai e para quem as relações pai precisam ser descobertas.

Retornos

Obter relações de ativos filho

Obtenha relações de ativo filho para uma ID de ativo pai. Consulte os documentos do Github para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo pai
parentAssetId True integer

A ID do ativo pai deve se referir ao ativo pai do servidor QPP.

Retornos

Obter resultados da consulta paginada com filtros

Essa solicitação retorna elemento de consulta paginado e detalhes de uma consulta armazenada no sistema com filtro específico na consulta. Para obter mais informações, verifique a documentação do github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID de consulta QPPNG existente
queryId True integer

Isso se refere a uma ID de consulta QPPNG existente.

ID da consulta
queryId integer

ID exclusiva da consulta.

Nome da consulta
queryName string

Nome da consulta.

ID do Proprietário
ownerId integer

ID do proprietário da consulta.

Parametrizada
parameterized boolean

Indica se a consulta é parametrizada.

ID da coluna
columnId True integer

ID da coluna de exibição.

Largura
width True integer

Largura da coluna de exibição.

Coluna de atributo
attributeColumn True boolean

Indica se a coluna é uma coluna de atributo.

ID da coluna
columnId integer

ID da coluna para classificação.

Decrescente
descending boolean

Indica se a classificação está em ordem decrescente.

Coluna de atributo
attributeColumn boolean

Indica se a coluna classificada é uma coluna de atributo.

Modo de Exibição
displayMode True integer

Configuração do modo de exibição.

ID do atributo
attributeId integer

ID do atributo para agrupamento.

Decrescente
descending boolean

Indica se o agrupamento está em ordem decrescente.

Explorar o Modo
exploreMode integer

Explore a configuração do modo.

Operador lógico
logicalOperator True integer

Operador lógico para a condição.

Operador de Comparação
comparisonOperator True integer

Operador de comparação para a condição.

Negado
negated True boolean

Indica se a condição está negada.

Parametrizada
parameterized True boolean

Indica se a condição é parametrizada.

Tipo
type True integer

Tipo da condição.

ID do atributo
attributeId True integer

ID do atributo para Pesquisa.

Valor a ser pesquisado em relação a
value True string

valor para Pesquisar Contra.

Tipo de conteúdo
contentType integer

ID do tipo de conteúdo para o contexto de consulta.

Collections
collections array of integer

Lista de IDs de coleção para o contexto de consulta.

Recursivo
recursive boolean

Indica se o contexto da consulta é recursivo.

Incluir todas as versões
includeAllVersions boolean

Indica se todas as versões estão incluídas no contexto de consulta.

Incluir branches
includeBranches boolean

Indica se os branches estão incluídos no contexto de consulta.

queryResults
queryResults

Retornos

Elemento de resposta para listar os resultados da consulta.

Elemento de resultado da consulta de resposta de lista
ListResponseQueryResultElement

Obter status de publicação

Obtenha o Status de Publicação para um determinado ativo. Consulte os documentos do Github para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID de contexto
contextId True string

ID de contexto

Retornos

Obter todas as consultas

Essa solicitação retornará toda a consulta com a definição de lá. Consulte os documentos do Github para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Retornos

Obter todos os usuários

Essa solicitação é usada para buscar todos os usuários. Consulte os documentos do Github para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Retornos

Elemento de resposta para listar usuários.

Listar usuário de resposta
ListResponseUser

Obter token de acordo com o tipo de concessão

Essa solicitação busca o token para o nome de usuário e a senha fornecidos para QPPNG. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome de usuário
username True string

Insira o nome de usuário do ambiente QPPNG para o qual você precisa obter o token.

Senha
password True string

Insira a senha do nome de usuário.

Retornos

Nome Caminho Tipo Description
Token de acesso
access_token string

O token que concede acesso aos recursos protegidos.

Expira em
expires_in integer

A duração (em segundos) para a qual o token de acesso é válido.

A atualização expira em
refresh_expires_in integer

A duração (em segundos) para a qual o token de atualização é válido.

Tipo de token
token_type string

O tipo do token (por exemplo, portador).

Não antes da política
not-before-policy integer

O tempo (em segundos) antes do qual o token não pode ser usado.

Scope
scope string

O escopo do token de acesso.

Obter Usuário por ID

Essa solicitação é usada para buscar os metadados de um usuário especificado. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID de usuário do QPPNG
userId True integer

ID do usuário QPPNG.

Retornos

Corpo
User

Obter usuário por nome

Essa solicitação retornará metadados do usuário específicos ao nome de usuário. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome de usuário para usuário do QPPNG
userName True string

Isso se refere ao nome de usuário do usuário QPPNG.

Retornos

Corpo
User

Obter valores de atributo de IDs

Obter valores de atributo para IDs separadas por vírgulas. Para obter mais informações, verifique a documentação do Github.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True integer

ID do Ativo na Plataforma QPPNG que está sendo apontada.

IDs de atributo QPPNG
attributeIds True string

IDs de atributo devem se referir às IDs de atributo do servidor QPP.

Retornos

Obter valores de atributos por nome

Obtenha valores de atributo para nomes separados por vírgulas. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True integer

AssetId deve se referir ao ativo do servidor QPP.

Nomes de atributo
attributes True string

A cadeia de caracteres de nomes de atributo deve se referir aos nomes de atributo do servidor QPPNG, separados por vírgula, se múltiplos.

Retornos

Publicar Ativo Assíncrono

Retorna a ID de Contexto do ativo que está sendo publicado. Use com o status de Obtenção de Publicação. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do ativo
assetId True string

AssetId variável deve se referir ao ativo do servidor QPP.

ID do Canal de Publicação
publishingChannelId True string

a variável channelId deve se referir à ID do canal a ser usada.

Retornos

ID de contexto do ativo que está sendo publicado. Use com o status de Publicação para verificar o status da publicação.

ID de contexto
string

É usuário um membro do grupo

Essa solicitação retornará true ou false de que um usuário é membro do grupo específico à userId.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

ID do usuário do QPPNG
userId True integer

ID do usuário QPPNG.

ID do grupo em QPPNG
groupId True integer

ID do grupo em QPPNG.

Gatilhos

Dispara quando um evento ocorre para um Webhook já registrado

Registra um webhook para um determinado evento e tipo de alteração. Consulte os documentos do GitHub para obter detalhes.

Dispara quando um evento ocorre para um Webhook já registrado

Registra um webhook para um determinado evento e tipo de alteração. Consulte os documentos do GitHub para obter detalhes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Usuário de representação
user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser representado.

Nome do webhook
name True string

Nome exclusivo para descrever o propósito e o significado dos webhooks.

Tipo de webhook
type True string

Descreva o Tipo de Webhook que será ouvido, como Evento etc.

Object
object True string

Descreve o tipo de Objeto a ser escutado como Ativo Semelhante etc.

Alterar Tipo
changeType True array of string
Critérios de filtro
filter string

Os critérios de filtro podem ser definidos para filtrar o tipo de evento.

Versão usada
version True string

Versão usada de acordo com o Serviço de webhook na plataforma QPPNG.

Retornos

Nome Caminho Tipo Description
Versão usada
version string

Versão usada de acordo com o serviço de webhook na plataforma QPPNG.

Tipo de webhook
webhookInfo.type string

Descreva o Tipo de Webhook que será ouvido, como Evento etc.

Webhook Id
webhookInfo.id string

ID do webhook.

Nome do webhook
webhookInfo.name string

Nome Exclusivo para descrever o propósito e o significado dos webhooks.

AuxData
webhookInfo.auxData string

AuxData se fornecido algum durante o registro.

Definições

PublishingOutputDownloadInfo

Define as informações de download de saída de publicação.

Nome Caminho Tipo Description
attributesMap
attributesMap object
Download Direto
directDownload boolean

Define se o Download Direto é permitido.

Baixar URL
downloadUrl string

Fornece a URL de download que pode ser usada com a ação de download de blob para baixar do local do blob.

WebhookSuccessResponse

Nome Caminho Tipo Description
ID
id string

Define a ID para a resposta de sucesso do webhook.

Situação
status string

Define o status da resposta de sucesso do webhook.

Message
message string

Define a mensagem para a resposta de sucesso do webhook.

Versão
version string

Define a versão para a resposta de sucesso do webhook.

AttributeValue

Nome Caminho Tipo Description
ID do atributo
attributeId integer

Define a ID do Atributo para o atributo QPPNG.

Nome do atributo
attributeName string

Define o Nome do Atributo para o atributo QPPNG.

Tipo
type integer

Define o tipo para o atributo QPPNG.

Multivalorado
multiValued boolean

Define se o atributo é de vários valores.

Value
attributeValue Value

Valor.

AssetUploadInfo

Nome Caminho Tipo Description
ID de contexto
contextId string

Define a ID de contexto para o upload do ativo.

Carregar URL
uploadUrl string

Define a URL de upload do ativo.

Ativo

Nome Caminho Tipo Description
ID do Ativo
assetId integer

Define a ID do ativo para o ativo QPPNG.

assetVersion
assetVersion AssetVersion
attributeValues
attributeValues array of AttributeValue

Utilizador

Nome Caminho Tipo Description
ID
id integer

ID de usuário.

Nome
name string

Nome do usuário.

ID do domínio
domainId integer

ID de domínio do usuário.

Referência de origem
sourceReference string

Referência de origem para o usuário.

Valores de domínio filho
childDomainValues array of DomainValue

Matriz de valores de domínio filho.

Tem filhos
hasChildren boolean

Indica se o usuário tem filhos.

Está Excluído
isDeleted boolean

Indica se o usuário foi excluído.

É Usuário
user boolean

Indica se a entidade é um usuário.

ID do perfil LDAP
ldapProfileId integer

ID do perfil LDAP para o usuário.

ID da classe de usuário padrão
defaultUserClassId integer

ID de classe de usuário padrão.

Endereço eletrônico
emailAddress string

Endereço de email do usuário.

Está Excluído
deleted boolean

Indica se o usuário foi excluído.

Nome Diferenciado LDAP
ldapDistinguishedName string

Nome diferenciado LDAP para o usuário.

Curador Nativo
nativeTrustee boolean

Indica se o usuário é um administrador nativo.

Primeiro Nome
firstName string

Nome do usuário.

Apelido
lastName string

Sobrenome do usuário.

Número de Telefone
phoneNumber string

Número de telefone do usuário.

Está habilitado
enabled boolean

Indica se o usuário está habilitado.

Autenticado externamente
externallyAuthenticated boolean

Indica se o usuário está autenticado externamente.

Nome da Autenticação
nameForAuthentication string

Nome da autenticação.

ListResponseCollectionGroup

Nome Caminho Tipo Description
Contagem
get_count integer

Número de itens na resposta.

Próximo Link
get_nextLink string

URL para o próximo conjunto de resultados.

Value
get_value array of CollectionGroup

Matriz de grupos de coleção.

Value

Valor.

Nome Caminho Tipo Description
Value
object

Valor.

AssetVersion

Nome Caminho Tipo Description
Versão Principal
majorVersion integer

Versão principal do ativo.

Versão Menor
minorVersion integer

Versão secundária do ativo.

Branch ID
branchId integer

ID da versão do branch.

Nome do sistema
systemName string

Nome do sistema para a versão do ativo.

DomainValue

Nome Caminho Tipo Description
ID
id integer

ID do valor do domínio.

Nome
name string

Nome do valor do domínio.

ID do domínio
domainId integer

ID de domínio do valor de domínio.

Referência de origem
sourceReference string

Referência de origem do valor de domínio.

Valores de domínio filho
childDomainValues string

Matriz de valores de domínio filho.

Tem filhos
hasChildren boolean

Indica se o valor do domínio tem filhos.

Está Excluído
isDeleted boolean

Indica se o valor do domínio é excluído.

CollectionGroup

Nome Caminho Tipo Description
ID do grupo
groupId integer

ID do grupo de coleção.

groupInfo
groupInfo GroupInfo
ID da classe de usuário substituída
overriddenUserClassId integer

ID da classe de usuário substituída.

GroupInfo

Nome Caminho Tipo Description
ID
id integer

ID do grupo.

Nome
name string

Nome do grupo.

ID do domínio
domainId integer

ID de domínio do grupo.

Referência de origem
sourceReference string

Referência de origem do grupo.

Valores de domínio filho
childDomainValues array of DomainValue

Matriz de valores de domínio filho.

Tem filhos
hasChildren boolean

Indica se o grupo tem filhos.

Está Excluído
isDeleted boolean

Indica se o grupo foi excluído.

É Usuário
user boolean

Indica se o grupo representa um usuário.

ID do perfil LDAP
ldapProfileId integer

ID do perfil LDAP.

ID da classe de usuário padrão
defaultUserClassId integer

ID da classe de usuário padrão.

Endereço eletrônico
emailAddress string

Endereço de email do grupo.

Excluído
deleted boolean

Indica se o grupo foi excluído.

Nome Diferenciado LDAP
ldapDistinguishedName string

Nome diferenciado LDAP do grupo.

Curador Nativo
nativeTrustee boolean

Indica se o grupo é um administrador nativo.

AssetDownloadInfo

Nome Caminho Tipo Description
ID de contexto
contextId string

ID do contexto.

Transferir URL
downloadUrl string

URL para baixar o ativo.

Workflow

Detalhes de um fluxo de trabalho.

Nome Caminho Tipo Description
ID
id integer

Identificador exclusivo para o fluxo de trabalho.

Nome
name string

Nome do fluxo de trabalho.

ID do domínio
domainId integer

Identificador do domínio associado ao fluxo de trabalho.

Referência de origem
sourceReference string

Referência associada à origem do fluxo de trabalho.

Valores de domínio filho
childDomainValues array of DomainValue

Lista de valores de domínio filho associados ao fluxo de trabalho.

Tem filhos
hasChildren boolean

Indica se o fluxo de trabalho tem filhos.

Está Excluído
isDeleted boolean

Indica se o fluxo de trabalho foi marcado como excluído.

Estados
statuses array of Status

Lista de status no fluxo de trabalho.

Criado por
createdBy integer

ID do usuário do criador do fluxo de trabalho.

Data de criação
created string

Data em que o fluxo de trabalho foi criado.

Última modificação feita por
lastModifiedBy integer

ID do usuário do último modificador do fluxo de trabalho.

Data da última modificação
lastModified string

Data em que o fluxo de trabalho foi modificado pela última vez.

Transição de status restrito
constrainedStatusTransition boolean

Define se a transição de status é restrita.

Classes de usuário de roteamento de status
statusRoutingUserclasses array of StatusRoutingUserClasses

Lista de classes de usuário de roteamento de status.

Transições de status
statusTransitions array of StatusTransition

Lista de transições de status.

Situação

Representa um status.

Nome Caminho Tipo Description
ID
id integer

Identificador exclusivo para o status.

Nome
name string

Nome do status.

ID do domínio
domainId integer

Identificador de domínio para o status.

Referência de origem
sourceReference string

Referência à origem do status.

Valores de domínio filho
childDomainValues array of DomainValue

Matriz de valores de domínio filho.

Tem filhos
hasChildren boolean

Indica se o status tem status filho.

Está Excluído
isDeleted boolean

Indica se o status é excluído.

ID do Fluxo de Trabalho
workflowId integer

ID do fluxo de trabalho associado ao status.

Cor vermelha
colorRed integer

Componente vermelho da cor de status.

Cor verde
colorGreen integer

Componente verde da cor de status.

Cor azul
colorBlue integer

Componente azul da cor de status.

Cargo
position integer

Posição do status.

StatusRoutingUserClasses

Mapeamento de status para classes de usuário para roteamento.

Nome Caminho Tipo Description
Status ID
statusId integer

ID do status do roteamento.

Roteamento de IDs de classe de usuário
routingUserClassIds array of integer

Matriz de IDs de classe de usuário para roteamento.

Roteamento baseado em classe de usuário
userClassBasedRouting boolean

Indica se o roteamento baseado em classe de usuário está habilitado.

StatusTransition

Detalhes de uma transição de status em um fluxo de trabalho.

Nome Caminho Tipo Description
Status ID
statusId integer

ID da transição de status.

Status de Iniciação do Fluxo de Trabalho
workflowInitiatingStatus boolean

Indica se a transição é iniciada pelo fluxo de trabalho.

Próximas IDs de status possíveis
nextPossibleStatusIds array of integer

IDs dos próximos status possíveis após essa transição.

AssetRelation

Detalhes de uma relação entre ativos.

Nome Caminho Tipo Description
ID
id integer

ID exclusiva da relação de ativo.

ID do ativo pai
parentAssetId integer

ID do ativo pai na relação.

parentAssetVersion
parentAssetVersion AssetVersion
ID do ativo filho
childAssetId integer

ID do ativo filho na relação.

childAssetVersion
childAssetVersion AssetVersion
ID do tipo de relação
relationTypeId integer

ID do tipo de relação.

Estado da relação
relationState integer

Estado da relação.

Bloqueado para a versão filho
lockedToChildVersion boolean

Sinalizador indicando se a relação está bloqueada para a versão filho.

Congelar para a versão atual
freezeToCurrentVersion boolean

Sinalizador indicando se a relação está congelada para a versão atual.

Atributos de relação
relationAttributes array of AttributeValue

Atributos associados à relação.

Attribute

Detalhes de um atributo associado a uma entidade.

Nome Caminho Tipo Description
ID
id integer

ID exclusiva do atributo.

Nome
name string

Nome do atributo.

Tipo de valor
valueType integer

Tipo de valor que o atributo contém.

Definido pelo usuário
userDefined boolean

Indica se o atributo está definido pelo usuário.

Consultável
queryable boolean

Indica se o atributo é consultável.

Valores Múltiplos
multiValued boolean

Indica se o atributo pode conter vários valores.

Nível de modificação
modificationLevel integer

Nível de modificação do atributo.

Data de criação
created string

Data em que o atributo foi criado.

Data da última modificação
lastModified string

Data em que o atributo foi modificado pela última vez.

Criador
creator integer

ID do usuário que criou o atributo.

Último Modificador
lastModifier integer

ID do usuário que modificou o atributo pela última vez.

Exibível
displayable boolean

Indica se o atributo é exibivel.

Acesso limitado
limitedAccess boolean

Indica se o atributo tem acesso limitado.

Acesso limitado alterável
limitedAccessChangeable boolean

Indica se a configuração de acesso limitado pode ser alterada.

Restrições alteráveis
constraintsChangeable boolean

Indica se as restrições do atributo podem ser alteradas.

Preferências de valor alteráveis
valuePreferencesChangeable boolean

Indica se as preferências de valor podem ser alteradas.

Preferências de valor booliano
booleanValuePreferences BooleanValuePreferences

Preferências para valores boolianos.

Preferências de valor numérico
numericValuePreferences NumericValuePreferences

Preferências para valores numéricos.

Preferências de valor de data
dateValuePreferences DateValuePreferences

Preferências para valores de data.

Preferências de valor datetime
dateTimeValuePreferences DateTimeValuePreferences

Preferências para valores DateTime.

Preferências de valor de hora
timeValuePreferences TimeValuePreferences

Preferências por valores de tempo.

Preferências de valor de medida
measurementValuePreferences MeasurementValuePreferences

Preferências para valores de medida.

Preferências de valor de texto
textValuePreferences TextValuePreferences

Preferências para valores de texto.

Preferências de lista de valores de domínio
domainValueListPreferences DomainValueListPreferences

Preferências para listas de valores de domínio.

Preferências de valor de domínio
domainValuePreferences DomainValuePreferences

Preferências para valores de domínio.

CreateAttributeSchema

Detalhes de um atributo associado a uma entidade.

Nome Caminho Tipo Description
ID
id integer

ID exclusiva do atributo.

Nome
name string

Nome do atributo.

Tipo de valor
valueType integer

Tipo de valor que o atributo contém 1 para tipo de texto etc.

Definido pelo usuário
userDefined boolean

Indica se o atributo está definido pelo usuário.

Consultável
queryable boolean

Indica se o atributo é consultável.

Valores Múltiplos
multiValued boolean

Indica se o atributo pode conter vários valores.

Nível de modificação
modificationLevel integer

Nível de modificação do atributo.

Data de criação
created string

Data em que o atributo foi criado.

Data da última modificação
lastModified string

Data em que o atributo foi modificado pela última vez.

Criador
creator integer

ID do usuário que criou o atributo.

Último Modificador
lastModifier integer

ID do usuário que modificou o atributo pela última vez.

Exibível
displayable boolean

Indica se o atributo é exibivel.

Acesso limitado
limitedAccess boolean

Indica se o atributo tem acesso limitado.

Acesso limitado alterável
limitedAccessChangeable boolean

Indica se a configuração de acesso limitado pode ser alterada.

Restrições alteráveis
constraintsChangeable boolean

Indica se as restrições do atributo podem ser alteradas.

Preferências de valor alteráveis
valuePreferencesChangeable boolean

Indica se as preferências de valor podem ser alteradas.

Preferências de valor booliano
booleanValuePreferences BooleanValuePreferences

Preferências para valores boolianos.

Preferências de valor numérico
numericValuePreferences NumericValuePreferences

Preferências para valores numéricos.

Preferências de valor de data
dateValuePreferences DateValuePreferences

Preferências para valores de data.

Preferências de valor datetime
dateTimeValuePreferences DateTimeValuePreferences

Preferências para valores DateTime.

Preferências de valor de hora
timeValuePreferences TimeValuePreferences

Preferências por valores de tempo.

Preferências de valor de medida
measurementValuePreferences MeasurementValuePreferences

Preferências para valores de medida.

Preferências de valor de texto
textValuePreferences TextValuePreferences

Preferências para valores de texto.

Preferências de lista de valores de domínio
domainValueListPreferences DomainValueListPreferences

Preferências para listas de valores de domínio.

Preferências de valor de domínio
domainValuePreferences DomainValuePreferences

Preferências para valores de domínio.

ContentTypeInfo

Detalhes de um tipo de conteúdo.

Nome Caminho Tipo Description
ID
id integer

ID exclusiva do tipo de conteúdo.

Nome
name string

Nome do tipo de conteúdo.

ID do domínio
domainId integer

ID de domínio associada ao tipo de conteúdo.

Referência de origem
sourceReference string

Referência à origem do tipo de conteúdo.

Valores de domínio filho
childDomainValues array of DomainValue

Lista de valores de domínio filho associados ao tipo de conteúdo.

Tem filhos
hasChildren boolean

Indica se o tipo de conteúdo tem filhos.

Está Excluído
isDeleted boolean

Indica se o tipo de conteúdo é excluído.

Sistema definido
systemDefined boolean

Indica se o tipo de conteúdo está definido pelo sistema.

Filhos Disponíveis
childrenAvailable boolean

Indica se os filhos estão disponíveis para o tipo de conteúdo.

Extensível
extensible boolean

Indica se o tipo de conteúdo é extensível.

BooleanValuePreferences

Preferências para valores boolianos.

Nome Caminho Tipo Description
Valor booliano
defaultValue BooleanValue

Valor booliano.

BooleanValue

Valor booliano.

Nome Caminho Tipo Description
Value
value boolean

O valor booliano.

NumericValuePreferences

Preferências para valores numéricos.

Nome Caminho Tipo Description
Valor numérico
minimumPossibleValue NumericValue

Valor numérico.

Valor numérico
maximumPossibleValue NumericValue

Valor numérico.

Valor numérico
defaultValue NumericValue

Valor numérico.

NumericValue

Valor numérico.

Nome Caminho Tipo Description
Value
value integer

O valor numérico.

DateValue

Valor da data.

Nome Caminho Tipo Description
Value
value string

O valor da data.

DateValuePreferences

Preferências para valores de data.

Nome Caminho Tipo Description
Valor da data
minimumPossibleValue DateValue

Valor da data.

Valor da data
maximumPossibleValue DateValue

Valor da data.

Valor da data
defaultValue DateValue

Valor da data.

DateTimeValue

Valor datetime.

Nome Caminho Tipo Description
Value
value string

O valor datetime.

DateTimeValuePreferences

Preferências para valores DateTime.

Nome Caminho Tipo Description
Valor datetime
minimumPossibleValue DateTimeValue

Valor datetime.

Valor datetime
maximumPossibleValue DateTimeValue

Valor datetime.

Valor datetime
defaultValue DateTimeValue

Valor datetime.

TimeValue

Valor de tempo.

Nome Caminho Tipo Description
Value
value string

O valor da hora.

TimeValuePreferences

Preferências por valores de tempo.

Nome Caminho Tipo Description
Valor de Hora
minimumPossibleValue TimeValue

Valor de tempo.

Valor de Hora
maximumPossibleValue TimeValue

Valor de tempo.

Valor de Hora
defaultValue TimeValue

Valor de tempo.

MeasurementValue

Valor da medida.

Nome Caminho Tipo Description
Value
value double

O valor da medida.

MeasurementValuePreferences

Preferências para valores de medida.

Nome Caminho Tipo Description
Unidade de Medida
measurementUnit integer

Unidade de medição.

Somente unidade de medição alterável
onlyMeasurementUnitChangeable boolean

Indica se apenas a unidade de medida é alterável.

Valor da medida
minimumPossibleValue MeasurementValue

Valor da medida.

Valor da medida
maximumPossibleValue MeasurementValue

Valor da medida.

Valor da medida
defaultValue MeasurementValue

Valor da medida.

TextValue

Valor do texto

Nome Caminho Tipo Description
Value
value string

O valor do texto.

TextValuePreferences

Preferências para valores de texto.

Nome Caminho Tipo Description
Valor do texto
defaultValue TextValue

Valor do texto

Comprimento máximo possível
maxLengthPossible integer

Comprimento máximo possível para o valor de texto.

Pesquisa de Texto Habilitada
textSearchEnabled boolean

Indica se a pesquisa de texto está habilitada.

DomainValueList

Lista de valores de domínio.

Nome Caminho Tipo Description
Valores de domínio
domainValues array of DomainValue

Lista de valores de domínio.

DomainValueListPreferences

Preferências para listas de valores de domínio.

Nome Caminho Tipo Description
Lista de valores de domínio
defaultValue DomainValueList

Lista de valores de domínio.

ID do domínio
domainId integer

ID de domínio associada à lista de valores de domínio.

DomainValuePreferences

Preferências para valores de domínio.

Nome Caminho Tipo Description
defaultValue
defaultValue DomainValue
ID do domínio
domainId integer

ID de domínio associada ao valor do domínio.

QueryDefinition

Definição de uma consulta.

Nome Caminho Tipo Description
ID da consulta
queryId integer

ID exclusiva da consulta.

Nome da consulta
queryName string

Nome da consulta.

ID do Proprietário
ownerId integer

ID do proprietário da consulta.

Parametrizada
parameterized boolean

Indica se a consulta é parametrizada.

Exibição de consulta
queryDisplay QueryDisplay

Exibir configurações de uma consulta.

Condições de consulta
queryConditions array of QueryCondition

Lista de condições de consulta.

Contexto de consulta
queryContext QueryContext

Configurações de contexto para uma consulta.

queryResults
queryResults

QueryDisplay

Exibir configurações de uma consulta.

Nome Caminho Tipo Description
Exibir Colunas
displayColumns array of DisplayColumn

Lista de colunas de exibição.

Classificação
sorting array of SortInfo

Lista de configurações de classificação.

Modo de Exibição
displayMode integer

Configuração do modo de exibição.

Agrupamento de atributos
groupingAttributes array of GroupingInfo

Lista de atributos de agrupamento.

Explorar o Modo
exploreMode integer

Explore a configuração do modo.

QueryCondition

Condição para uma consulta.

Nome Caminho Tipo Description
Operador lógico
logicalOperator integer

Operador lógico para a condição.

Operador de Comparação
comparisonOperator integer

Operador de comparação para a condição.

Negado
negated boolean

Indica se a condição está negada.

Parametrizada
parameterized boolean

Indica se a condição é parametrizada.

Tipo
type integer

Tipo da condição.

ID do atributo
attributeId integer

ID do atributo para Pesquisa.

Valor a ser pesquisado em relação a
value string

valor para Pesquisar Contra.

QueryContext

Configurações de contexto para uma consulta.

Nome Caminho Tipo Description
Tipo de conteúdo
contentType integer

ID do tipo de conteúdo para o contexto de consulta.

Collections
collections array of integer

Lista de IDs de coleção para o contexto de consulta.

Recursivo
recursive boolean

Indica se o contexto da consulta é recursivo.

Incluir todas as versões
includeAllVersions boolean

Indica se todas as versões estão incluídas no contexto de consulta.

Incluir branches
includeBranches boolean

Indica se os branches estão incluídos no contexto de consulta.

DisplayColumn

Coluna para exibição em uma consulta.

Nome Caminho Tipo Description
ID da coluna
columnId integer

ID da coluna de exibição.

Largura
width integer

Largura da coluna de exibição.

Coluna de atributo
attributeColumn boolean

Indica se a coluna é uma coluna de atributo.

SortInfo

Configurações de classificação para uma consulta.

Nome Caminho Tipo Description
ID da coluna
columnId integer

ID da coluna para classificação.

Decrescente
descending boolean

Indica se a classificação está em ordem decrescente.

Coluna de atributo
attributeColumn boolean

Indica se a coluna classificada é uma coluna de atributo.

GroupingInfo

Configurações de agrupamento para uma consulta.

Nome Caminho Tipo Description
ID do atributo
attributeId integer

ID do atributo para agrupamento.

Decrescente
descending boolean

Indica se o agrupamento está em ordem decrescente.

ListResponseQueryResultElement

Elemento de resposta para listar os resultados da consulta.

Nome Caminho Tipo Description
Contagem
get_count integer

Número de resultados na resposta da lista.

Próximo Link
get_nextLink string

Link para a próxima página de resultados.

Value
get_value array of QueryResultElement

Matriz de elementos de resultado da consulta.

QueryResultElement

Elemento em um resultado de consulta.

Nome Caminho Tipo Description
ID
id integer

Identificador exclusivo para o elemento.

Filho Disponível
childAvailable boolean

Indica se os elementos filho estão disponíveis.

Tipo de elemento
elementType integer

Tipo do elemento.

ListResponseUser

Elemento de resposta para listar usuários.

Nome Caminho Tipo Description
Contagem
get_count integer

Número de usuários na resposta da lista.

Próximo Link
get_nextLink string

Link para a próxima página de resultados.

Value
get_value array of User

Matriz de elementos de usuário.

PublishingStatusInfo

Nome Caminho Tipo Description
PublishingFailedException
publishingFailedException PublishingFailedException

Exceção gerada quando a publicação falha

publishingOutputDownloadInfo
publishingOutputDownloadInfo array of PublishingOutputDownloadInfo
Status de publicação
publishingStatus string

Status da publicação do ativo, possíveis valores retornados são PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED

PublishingFailedException

Exceção gerada quando a publicação falha

Nome Caminho Tipo Description
Informações adicionais
additionalInfo array of string

Informações adicionais relacionadas à exceção

Jogáveis
cause Throwable

Classe base para exceções e erros

Código de Exceção
exceptionCode string

Código associado à exceção

Mensagem localizada
localizedMessage string

Mensagem localizada que descreve a exceção

Message
message string

Mensagem que descreve a exceção

stackTrace
stackTrace array of StackTraceElement
suprimido
suppressed array of Throwable

Jogáveis

Classe base para exceções e erros

Nome Caminho Tipo Description
Motivo
cause string

A causa do jogo

Mensagem localizada
localizedMessage string

Mensagem localizada que descreve o throwable

Message
message string

Mensagem que descreve o throwable

stackTrace
stackTrace array of StackTraceElement
Suprimido
suppressed array of string

Outros throwables suprimidos por este throwable

StackTraceElement

Um elemento que representa um único quadro de pilha

Nome Caminho Tipo Description
Nome da classe
className string

Nome da classe que contém o ponto de execução

Nome do Arquivo
fileName string

Nome do arquivo que contém o ponto de execução

Número de Linha
lineNumber integer

Número de linha no arquivo que contém o ponto de execução

Nome do método
methodName string

Nome do método que contém o ponto de execução

Método nativo
nativeMethod boolean

Indica se o método é um método nativo

Grupo

Nome Caminho Tipo Description
childDomainValues
childDomainValues array of DomainValue
ID da classe de usuário padrão
defaultUserClassId integer

A ID de classe de usuário padrão para o grupo.

Excluído
deleted boolean

Indica se o grupo foi excluído.

ID do domínio
domainId integer

A ID do domínio ao qual o grupo pertence.

Endereço eletrônico
emailAddress string

O endereço de email associado ao grupo.

Tem filhos
hasChildren boolean

Indica se o grupo tem filhos.

ID
id integer

A ID do grupo.

Está Excluído
isDeleted boolean

Indica se o grupo foi excluído.

Nome Diferenciado LDAP
ldapDistinguishedName string

O nome diferenciado em LDAP para o grupo.

ID do perfil LDAP
ldapProfileId integer

A ID do perfil LDAP para o grupo.

IDs de membro
memberIds array of integer

Uma matriz de IDs de membro associadas ao grupo.

Nome
name string

O nome do grupo.

Curador Nativo
nativeTrustee boolean

Indica se o grupo é um administrador nativo.

Referência de origem
sourceReference string

A referência de origem para o grupo.

Utilizador
user boolean

Indica se o grupo é um usuário.

inteiro

Esse é o tipo de dados básico 'integer'.

cadeia

Esse é o tipo de dados básico 'string'.