Partilhar via

QPP NextGen (Pré-visualização)

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

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Técnico Quark
URL https://quarksoftware.my.site.com
Email support_cases@quark.com
Metadados do conector
Editora Quark Software Inc.
Sítio Web https://www.quark.com/
Política de privacidade https://www.quark.com/privacy-policy
Categorias Conteúdos e Ficheiros; Produtividade

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

Pré-requisitos

  • Você precisa de um ambiente QPP-NG (v3.3 acima) e QPP-NG licenças para usar nosso conector.
  • Você precisa ter um cliente existente (Conexão), de preferência 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 poder, automatizar e obter valor usando conteúdo dinâmico ou a partir de outras ações, resposta usando o criador de consultas.

Como obter credenciais

Ao criar uma nova conexão com o nosso conector, você verá 3 parâmetros. Os detalhes para adquirir cada um são compartilhados abaixo. Criação e manaAo criar uma nova conexão com o nosso conector, os usuários verão 3 parâmetros. Os detalhes para adquirir cada um são compartilhados abaixo. A criação e o gerenciamento de conexões QPP-NG devem ser feitos pelo usuário administrador. Por favor, verifique com o administrador do seu QPP-NG ambientes.

Você também pode nomear suas credenciais adequadamente para identificá-las facilmente mais tarde. Aceda a Ligações no Power Automate, procure o nome do conector e edite uma ligação existente e, em seguida, forneça um nome adequado.

  • ID do cliente: Você pode navegar até o aplicativo Admin 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 já existente. Basta digitar o nome da conexão para ID do cliente.
  • Segredo do cliente: Como ID do cliente, navegue até Conexões e digite Segredo para a conexão existente. Regenere o segredo se não o tiver. Os segredos devem ser armazenados para conexões existentes de forma segura, gerenciados pelo administrador. Verifique com o administrador antes de regenerar o segredo.
  • Nome do anfitrião: O nome do host para o locatário QPP-NG que você deseja criar conexões para interagir com nosso conector. exemplo (yourtenantname.app.quark.com). Deve estar visível o URL, quando acede ao seu ambiente QPP-NG.

Depois de criar Credenciais, você pode testá-las para ver se as credenciais estão corretas.

Ações simples como getUser podem ser usadas a partir do 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álido (500): Verifique o nome do host para o ambiente QPP-NG novamente, o ID do cliente e o segredo devem pertencer a essa conexão.
  • Não autorizados/unauthorized_client (401): Para credenciais de cliente inválido ou cliente inválido, 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 grande variedade de eventos de Type Asset, Collections, etc. do seu locatário QPP-NG usando o Trigger integrado.

  • Crie um novo fluxo de automação no Power Automate.
  • Selecione nosso conector QPP-NG e, em seguida, escolha um gatilho.
  • Preencha os campos obrigatórios. Consulte a seção Webhook-trigger na documentação Leiame do Github.
  • Selecione a Conexão apropriada para o locatário QPP-NG onde você deseja registrar o webhook. Você também pode criar novas conexões. Siga as etapas fornecidas na seção Como obter credenciais .
  • Guarde o fluxo. Isso executará a solicitação de registro no verso. Quando você retornar à página de detalhes do fluxo (ou clicar no botão Voltar), você verá um sublinhado verde na parte superior mencionando que tudo correu bem e o fluxo está pronto para ser acionado.
  • 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 parse json OOTB.
  • Caso este seja o primeiro webhook com esse tipo de alteração (evento) registrado no locatário QPP-NG, você precisa aguardar 15 minutos antes que o webhook seja ativado e, em seguida, você pode esperar que o fluxo seja acionado.

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

  • Webhook com nome já existe Forneça um nome exclusivo para o webhook ou use a operação Delete 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 Quark Developer.
  • Mau pedido(400) Por favor, verifique os Params fornecidos de acordo com a documentação e detalhes do erro.
  • Recurso não encontrado (404) & O cabeçalho de localização está ausente na solicitação de assinatura Exclua o fluxo e, em seguida, crie um novo gatilho e fluxo de webhook. Se o fluxo for grande, duplique o fluxo e, ao ativar o fluxo e salvar, o Power Automate tentará fazer um novo registro de webhook.

Problemas conhecidos e limitações

  • Atualmente, você não poderá atualizar 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 de QPP-NG em seu lugar. Para excluir o webhook registrado anteriormente do ambiente QPP-NG, crie um novo fluxo manual com a operação delete, selecione o webhook anterior na lista suspensa e execute o fluxo. Se essa solução alternativa não funcionar e o fluxo for grande, duplique o fluxo e, depois de atualizar os detalhes do webhook, salve-o e habilite-o. Isso também criará um novo registro de webhook com sucesso.
  • 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 QPP-NG webhook não puder invocar o webhook-trigger registrado por 3 vezes, o webhook será desativado.
  • Salvar certas ações sem parâmetros dados (vazio) dá um erro (espere algum valor no corpo).
  • Se este for o primeiro webhook com esse tipo de alteração (evento), você precisará esperar por 15 minutos antes que o webhook seja ativado e, em seguida, você pode esperar que o fluxo seja acionado.
  • Use a visualização Legacy designer 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 Webhooks Trigger como um primeiro passo, pode haver um problema no registro em 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, onde as execuções dos últimos 28 dias são mostradas. Se ele mostrar vermelho, isso significa que o webhook não foi registrado corretamente. Por favor, verifique o erro. Se o erro ocorrer devido ao cabeçalho Location estar ausente ou o recurso não ser encontrado, tente excluir e criar o gatilho novamente.
  • Se seus fluxos não estão sendo acionados, isso pode ser devido a um webhook existente que está registrado como um ponto de extremidade que não existe, como um fluxo excluído, etc. Em tal situação, execute API https://{Host.name}/webhooks/api/v3/registrations com seu token api para obter uma lista de todos os webhooks registrados no ambiente QPP-NG e use essa resposta para remover tais webhooks usando a ação excluir webhooks. Você também precisa garantir que o serviço webhooks esteja configurado corretamente e em execução a partir do seu suporte ao 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,
  • Em caso de problemas específicos da Ação, consulte exemplos e documentação compartilhados no repositório de código aberto no Github em Readme.md arquivo 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 diferentes ambientes QPP-NG?

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

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

Com certeza. Basta enviar um e-mail para [email protected] (https://quarksoftware.my.site.com) e certifique-se de mencionar o Microsoft Power Automate Connector quando descrever o problema.

Onde posso obter mais informações sobre as ações e os parâmetros?

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

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) Especifique a ID do Cliente a partir de suas credenciais de serviço. Verdade
Segredo do Cliente (clientSecret) securestring Especifique o Segredo do Cliente a partir das suas credenciais de serviço. Verdade
Nome do anfitrião cadeia (de caracteres) Especifique o nome do host Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Atualizar mapeamento de atributos para tipo de conteúdo

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

Esta solicitação é usada para baixar o arquivo por fluxo de entrada do URL de download. Consulte os documentos do GitHub para obter detalhes.
Carregar (Blob)

Esta solicitação é usada para carregar 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 junto com uma mensagem de êxito. 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, consulte 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 atributos para a Plataforma QPP. Para obter mais informações, consulte a documentação do Github.
Exclui Webhook

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

Marca o ativo com o assetId fornecido como Check-out. Consulte os documentos do Github para obter detalhes.
Iniciar Check-in e Atualização

A solicitação fará o check-in e atualizará um ativo já existente no QPPNG. Ativo Precisa ser verificado antes. Use a ação de check-out antes. Para obter mais informações, consulte 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 dada, por exemplo, os valores de atributos necessários são nome, coleção, extensão, etc. para fazer check-in de um ativo para QPPNG. Para obter mais informações, consulte a documentação do github.
O usuário é um membro do grupo

Essa solicitação retornará true ou false que um usuário é membro de um grupo específico para o userId.
Obtenha relações com os ativos da empresa-mãe

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

Obtenha Relações de Ativos Filho para um ID de Ativo Pai. Consulte os documentos do Github para obter detalhes.
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 pelo nome. Consulte os documentos do Github para obter detalhes.
Obter grupo por nome

Essa solicitação retornará um grupo específico para o 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 fornecida para o fluxo de trabalho e o status especificados. Para obter mais informações, consulte 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 em conjunto com Download Blob Action to Download The asset stream. Para obter mais informações, consulte a documentação do github.
Obter informações sobre tipos de conteúdo por nome

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

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

Obtenha dados de ativos para determinado ID de ativo. Para obter mais informações, consulte a documentação do Github.
Obter resultados de consulta paginados com filtros

Esta solicitação retorna o Elemento de Consulta paginado e detalhes de uma Consulta armazenada no sistema com filtro específico na consulta. Para obter mais informações, consulte a documentação do github.
Obter status de publicação

Obter status de publicação para um determinado ativo. Consulte os documentos do Github para obter detalhes.
Obter todas as consultas

Esta solicitação retornará toda a consulta com a definição existente. 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

Esta solicitação busca o token para o nome de usuário e 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 de usuário específicos para o nome de usuário. Consulte os documentos do GitHub para obter detalhes.
Obter valores de atributo de Ids

Obtenha valores de atributo para Id's separados por vírgula. Para obter mais informações, consulte a documentação do Github.
Obter valores de atributos por nome

Obtenha valores de atributo para nomes separados por vírgula. Consulte os documentos do GitHub para obter detalhes.
Publicar assíncrono de ativos

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

Atualizar mapeamento de atributos para tipo de conteúdo

ID da Operação:
AddAttributeToContentTypes

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
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 para os quais esses atributos precisam ser mapeados.

Baixar (Blob)

ID da Operação:
DownloadBlob

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

Parâmetros

Name Chave Necessá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

File Identifier refere-se ao tipo de arquivo.
ID de contexto
 contextId True string

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

Devoluções

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

O tipo de conteúdo do documento, por exemplo, aplicação/pdf.
Content
 $content byte

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

Carregar (Blob)

ID da Operação:
UploadBlob

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Identificador de arquivo
 fileIdentifier True string

File Identifier refere-se ao tipo de arquivo.
ID de contexto
 contextId True string

Id de contexto refere-se a informações de recurso.
Recurso de fluxo de entrada
 InputStreamResource True

Fluxo de entrada para recurso, precisa de entrada binária.

Cria um novo atributo

ID da Operação:
CreateAttribute

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nome
 name True string

Nome do atributo.
Tipo de atributo
 valueType True integer

Tipo de Atributo.

Devoluções

Detalhes de um atributo associado a uma entidade.

Attribute
CreateAttributeSchema

Cria um novo atributo List

ID da Operação:
CreateListAttribute

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Número de domínios a mostrar
 _skiptoken True integer

Número de domínios a serem ignorados da lista suspensa ID do domínio.
Nome
 name True string

Nome do atributo.
Tipo de atributo
 valueType True integer

Tipo de Atributo, deve ser lista para tipo de lista.
Multi Valorados
 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 associado à lista de Fonte de Dados/Domínio existente. Use o token de pulo para percorrer 20 itens no menu suspenso.

Devoluções

Detalhes de um atributo associado a uma entidade.

Attribute
CreateAttributeSchema

Criar consulta

ID da Operação:
CreateQuery

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Número de atributos a serem ignorados
 _skiptoken True integer

Número de atributos a serem ignorados da lista suspensa de atributos.
Nome da consulta
 queryName True string

Nome da consulta.
Parametrizado
 parameterized boolean

Indica se a consulta está parametrizada.
ID do atributo
 attributeId integer

ID do atributo para pesquisa.
Tipo de atributo
 type integer

Tipo do atributo selecionado 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 é negada.
Valor para pesquisar contra
 value string

valor para Procurar contra.
Operador lógico
 logicalOperator integer

Operador lógico e OR para a condição.
ID da coluna
 columnId True integer

ID da coluna de exibição.
Largura
 width True integer

Largura da coluna de visualização.
Coluna de atributos
 attributeColumn True boolean

Indica se a coluna é uma coluna de atributo.
Modo de Visualização
 displayMode True integer

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

Devoluções

ID de consulta recém-criada.

ID de consulta recém-criada
integer

Definir valores de atributo

ID da Operação:
SetAttributeValues

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
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.
Multi Valorados
 multiValued boolean

Indica se o atributo é multivalorado.
Valor
 attributeValue object

valor.

Exclui Webhook

ID da Operação:
Delete-webhook-trigger

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nome ou ID
 nameOrId True string

Nome ou ID do webhook existente no ambiente.

Devoluções

Body
WebhookSuccessResponse

Finalizar Encomenda

ID da Operação:
CheckOut

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo
 assetId True integer

A variável assetId deve referir-se ao Ativo do Servidor QPP.
ID do atributo
 attributeId integer

Identificador do atributo.
Tipo
 type integer

Tipo do atributo.
Valor
 attributeValue object

valor.

Devoluções

Body
Asset

Iniciar Check-in e Atualização

ID da Operação:
InitCheckin

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Criar versão secundária
 createMinorVersion True boolean

A variável createMinorVersion deve referir-se a true ou false para criar a versão para verificação.
ID do ativo
 assetId integer

ID do ativo para o ativo a ser verificado.

Devoluções

Body
AssetUploadInfo

Iniciar novo check-in

ID da Operação:
InitNewCheckin

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Número de atributos/domínios a serem ignorados
 _skiptoken True integer

Número de atributos/domínios a serem ignorados.
Criar versão secundária
 createMinorVersion True boolean

A variável createMinorVersion deve referir-se a true ou false para criar a versão para verificação.
ID do atributo
 attributeId integer

ID do atributo.
Tipo de atributo
 type integer

Tipo de Atributo.
Multi Valorados
 multiValued boolean

Indica se o atributo é multivalorado.
Id
 id integer

Id correspondente ao nome, como para Home collection Id 1 é tomado.
Nome
 name string

Nome para Atributo, como nome do tipo de conteúdo ou nome da coleção.
ID do Domínio
 domainId integer

ID de domínio associado à lista de Fonte de Dados/Domínio existente. Seu Id para o domínio.
Valor
 value string

Valor do atributo a ser definido.
ID do valor do domínio
 id integer

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

Devoluções

Body
AssetUploadInfo

O usuário é um membro do grupo

ID da Operação:
IsGroupMember

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Id do usuário QPPNG
 userId True integer

Id do usuário QPPNG.
Id para Grupo em QPPNG
 groupId True integer

Id para o grupo em QPPNG.

Obtenha relações com os ativos da empresa-mãe

ID da Operação:
GetParentAssetRelations

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo filho
 childAssetId True integer

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

Devoluções

response
array of AssetRelation

Obtenha relações patrimoniais infantis

ID da Operação:
GetChildAssetRelations

Obtenha Relações de Ativos Filho para um ID de Ativo Pai. Consulte os documentos do Github para obter detalhes.

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo pai
 parentAssetId True integer

O ID do Ativo Pai deve referir-se ao Ativo pai do Servidor QPP.

Devoluções

response
array of AssetRelation

Obter atributos por nome

ID da Operação:
GetAttributesByName

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nomes de atributos
 attributeNames True string

Nome do atributo deve referir-se ao nome do atributo do servidor QPP (separado por vírgula, se múltiplo).

Devoluções

response
array of Attribute

Obter fluxo de trabalho por nome

ID da Operação:
GetWorkflowByName

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nome do fluxo de trabalho
 workflowName True string

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

Devoluções

Detalhes de um fluxo de trabalho.

Workflow
Workflow

Obter grupo por nome

ID da Operação:
GetGroupByName

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nome do Grupo
 groupName True string

Variable groupName deve referir-se ao nome do grupo QPP Server.

Devoluções

Body
Group

Obter grupos para uma coleção

ID da Operação:
GetCollectionGroups

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Id para Coleção QPPNG
 collectionId True integer

A variável collectionId deve referir-se ao QPPNG Collection Id.

Devoluções

Body
ListResponseCollectionGroup

Obter informações de download de ativos

ID da Operação:
GetAssetDownloadInfo

A solicitação retornará informações de download de ativos que podem ser usadas em conjunto com Download Blob Action to Download The asset stream. Para obter mais informações, consulte a documentação do github.

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo
 assetId True integer

AssetId deve referir-se ao Ativo do Servidor QPP.
Versão Menor
 minorVersion integer

A Versão Secundária deve referir-se à 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 referir-se à versão principal do ativo necessária. Forneça null para buscar metadados da versão mais recente.

Devoluções

Body
AssetDownloadInfo

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

ID da Operação:
GetContentTypesInfoByName

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nome do tipo de conteúdo
 contentTypeName True string

Nome para o tipo de conteúdo.

Devoluções

response
array of ContentTypeInfo

Obter membros do grupo

ID da Operação:
GetGroupMembers

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do Grupo
 groupId True integer

O ID do Grupo deve referir-se ao Grupo QPPNG.

Devoluções

response
array of User

Obter metadados de ativos

ID da Operação:
GetAsset

Obtenha dados de ativos para determinado ID de ativo. Para obter mais informações, consulte a documentação do Github.

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo
 assetId True integer

Id para o Ativo na Plataforma QPPNG que está sendo apontado.

Devoluções

Body
Asset

Obter resultados de consulta paginados com filtros

ID da Operação:
GetPaginatedQueryResultsWithFilters

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID de consulta QPPNG existente
 queryId True integer

Isto refere-se a um ID de consulta QPPNG existente.
ID da consulta
 queryId integer

ID exclusivo da consulta.
Nome da consulta
 queryName string

Nome da consulta.
ID do Proprietário
 ownerId integer

ID do proprietário da consulta.
Parametrizado
 parameterized boolean

Indica se a consulta está parametrizada.
ID da coluna
 columnId True integer

ID da coluna de exibição.
Largura
 width True integer

Largura da coluna de visualização.
Coluna de atributos
 attributeColumn True boolean

Indica se a coluna é uma coluna de atributo.
ID da coluna
 columnId integer

ID da coluna para classificação.
Descending
 descending boolean

Indica se a classificação está em ordem decrescente.
Coluna de atributos
 attributeColumn boolean

Indica se a coluna classificada é uma coluna de atributo.
Modo de Visualização
 displayMode True integer

Configuração do modo de exibição.
ID do atributo
 attributeId integer

ID do atributo para agrupamento.
Descending
 descending boolean

Indica se o agrupamento está em ordem decrescente.
Modo de Exploração
 exploreMode integer

Explorar 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 é negada.
Parametrizado
 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 para pesquisar contra
 value True string

valor para Procurar 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 filiais
 includeBranches boolean

Indica se as ramificações estão incluídas no contexto de consulta.
queryResultados
 queryResults

Devoluções

Elemento de resposta para listar os resultados da consulta.

Elemento de resultado da consulta de resposta de lista
ListResponseQueryResultElement

Obter status de publicação

ID da Operação:
GetPublishingStatus

Obter status de publicação para um determinado ativo. Consulte os documentos do Github para obter detalhes.

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID de contexto
 contextId True string

ID de contexto

Devoluções

Body
PublishingStatusInfo

Obter todas as consultas

ID da Operação:
GetAllQueries

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

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

Devoluções

response
array of QueryDefinition

Obter todos os usuários

ID da Operação:
GetAllUsers

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

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

Devoluções

Elemento de resposta para listar usuários.

Listar usuário de resposta
ListResponseUser

Obter token de acordo com o tipo de concessão

ID da Operação:
TokenFromAuthWrapper

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

Parâmetros

Name Chave Necessário Tipo Description
Nome de utilizador
 username True string

Por favor, insira seu nome de usuário do ambiente QPPNG para o qual você precisa obter token.
Palavra-passe
 password True string

Introduza a palavra-passe do nome de utilizador.

Devoluções

Name 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.
Refresh 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

ID da Operação:
GetUser

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do usuário QPPNG
 userId True integer

Id para o usuário QPPNG.

Devoluções

Body
User

Obter usuário por nome

ID da Operação:
GetUserByName

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
Nome de utilizador para utilizador QPPNG
 userName True string

Isto refere-se ao nome de utilizador do utilizador QPPNG.

Devoluções

Body
User

Obter valores de atributo de Ids

ID da Operação:
GetAttributeValues

Obtenha valores de atributo para Id's separados por vírgula. Para obter mais informações, consulte a documentação do Github.

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo
 assetId True integer

Id para o Ativo na Plataforma QPPNG que está sendo apontado.
IDs de atributo QPPNG
 attributeIds True string

As ids de atributo devem referir-se às ids de atributo do Servidor QPP.

Devoluções

response
array of AttributeValue

Obter valores de atributos por nome

ID da Operação:
GetAttributeValuesByName

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo
 assetId True integer

AssetId deve referir-se ao Ativo do Servidor QPP.
Nomes de atributos
 attributes True string

A cadeia de caracteres de nomes de atributos deve referir-se aos nomes de atributos do Servidor QPPNG, separados por vírgulas se múltiplos.

Devoluções

response
array of AttributeValue

Publicar assíncrono de ativos

ID da Operação:
PublishAssetAsync

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
ID do ativo
 assetId True string

A variável assetId deve referir-se ao Ativo do Servidor QPP.
ID do canal de publicação
 publishingChannelId True string

variável channelId deve referir-se ao Id do canal a ser usado.

Devoluções

ID de contexto para o ativo que está sendo publicado. Use com get Status de publicação para verificar o status de publicação.

ID de contexto
string

Acionadores

Aciona quando ocorre um evento para um Webhook já registrado

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

Aciona quando ocorre um evento para um Webhook já registrado

ID da Operação:
Webhook-trigger

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

Parâmetros

Name Chave Necessário Tipo Description
Usuário de falsificação de identidade
 user_name True string

Nome de usuário para o usuário QPPNG, que precisa ser personificado.
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.
Objeto
 object True string

Descreve o tipo de objeto a ser escutado, como, ASSET, 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 utilizada
 version True string

Versão usada como por serviço webhook na plataforma QPPNG.

Devoluções

Name Caminho Tipo Description
Versão utilizada
 version string

Versão usada como por serviço 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 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 durante o registo.

Definições

PublishingOutputDownloadInfo

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

Name Caminho Tipo Description
atributosMapa
 attributesMap object
Download Direto
 directDownload boolean

Define se o Download Direto é permitido.
Baixar Url
 downloadUrl string

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

WebhookSuccessResponse

Name Caminho Tipo Description
ID
 id string

Define o 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

Name 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.
Multivalorados
 multiValued boolean

Define se o atributo é de vários valores.
Valor
 attributeValue Value

valor.

AssetUploadInfo

Name Caminho Tipo Description
ID de contexto
 contextId string

Define o ID de contexto para o carregamento do ativo.
URL de carregamento
 uploadUrl string

Define a URL de carregamento para o ativo.

Ativo

Name Caminho Tipo Description
ID do ativo
 assetId integer

Define o ID do ativo para o ativo QPPNG.
assetVersion
 assetVersion AssetVersion
attributeValues
 attributeValues array of AttributeValue

User

Name Caminho Tipo Description
ID
 id integer

ID de Utilizador.
Nome
 name string

Nome do utilizador.
ID de Domínio
 domainId integer

ID de domínio do usuário.
Referência da fonte
 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.
É suprimido
 isDeleted boolean

Indica se o usuário foi excluído.
É Utilizador
 user boolean

Indica se a entidade é um usuário.
ID do perfil LDAP
 ldapProfileId integer

ID do perfil LDAP para o usuário.
ID de classe de usuário padrão
 defaultUserClassId integer

ID de classe de usuário padrão.
Endereço de E-mail
 emailAddress string

Endereço de e-mail do usuário.
É suprimido
 deleted boolean

Indica se o usuário foi excluído.
Nome distinto LDAP
 ldapDistinguishedName string

Nome distinto LDAP para o usuário.
Administrador nativo
 nativeTrustee boolean

Indica se o usuário é um administrador nativo.
Nome Próprio
 firstName string

Nome do usuário.
Apelido
 lastName string

Apelido do utilizador.
Número de Telefone
 phoneNumber string

Número de telefone do utilizador.
Está ativado
 enabled boolean

Indica se o usuário está habilitado.
Autenticado externamente
 externallyAuthenticated boolean

Indica se o usuário está autenticado externamente.
Nome para autenticação
 nameForAuthentication string

Nome para autenticação.

ListResponseCollectionGroup

Name Caminho Tipo Description
Contar
 get_count integer

Número de itens na resposta.
Próximo link
 get_nextLink string

URL para o próximo conjunto de resultados.
Valor
 get_value array of CollectionGroup

Matriz de grupos de coleta.

Valor

valor.

Name Caminho Tipo Description
Valor
 object

valor.

AssetVersion

Name Caminho Tipo Description
Versão principal
 majorVersion integer

Versão principal do ativo.
Versão Menor
 minorVersion integer

Versão secundária do ativo.
ID da filial
 branchId integer

ID da versão da filial.
Nome do sistema
 systemName string

Nome do sistema para a versão do ativo.

DomainValue

Name Caminho Tipo Description
ID
 id integer

ID do valor do domínio.
Nome
 name string

Nome do valor do domínio.
ID de Domínio
 domainId integer

ID de domínio do valor do domínio.
Referência da fonte
 sourceReference string

Referência de origem do valor do 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.
É suprimido
 isDeleted boolean

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

Grupo de Coleção

Name Caminho Tipo Description
ID do grupo
 groupId integer

ID do grupo de coleção.
groupInfo
 groupInfo GroupInfo
ID de classe de usuário substituída
 overriddenUserClassId integer

ID da classe de usuário substituída.

GroupInfo

Name Caminho Tipo Description
ID
 id integer

ID do grupo.
Nome
 name string

Nome do grupo.
ID de Domínio
 domainId integer

ID de domínio do grupo.
Referência da fonte
 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.
É suprimido
 isDeleted boolean

Indica se o grupo foi excluído.
É Utilizador
 user boolean

Indica se o grupo representa um usuário.
ID do perfil LDAP
 ldapProfileId integer

ID do perfil LDAP.
ID de classe de usuário padrão
 defaultUserClassId integer

ID da classe de usuário padrão.
Endereço de E-mail
 emailAddress string

Endereço de e-mail do grupo.
Suprimido
 deleted boolean

Indica se o grupo foi excluído.
Nome distinto LDAP
 ldapDistinguishedName string

Nome distinto LDAP do grupo.
Administrador nativo
 nativeTrustee boolean

Indica se o grupo é um administrador nativo.

AssetDownloadInfo

Name Caminho Tipo Description
ID de contexto
 contextId string

ID do contexto.
Download URL
 downloadUrl string

URL para baixar o ativo.

Workflow

Detalhes de um fluxo de trabalho.

Name Caminho Tipo Description
ID
 id integer

Identificador exclusivo para o fluxo de trabalho.
Nome
 name string

Nome do fluxo de trabalho.
ID de Domínio
 domainId integer

Identificador do domínio associado ao fluxo de trabalho.
Referência da fonte
 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.
É suprimido
 isDeleted boolean

Indica se o fluxo de trabalho foi marcado como excluído.
Estatutos
 statuses array of Status

Lista de status no fluxo de trabalho.
Criado por
 createdBy integer

ID de usuário do criador do fluxo de trabalho.
Data de criação
 created string

Data em que o fluxo de trabalho foi criado.
modificado pela última vez por
 lastModifiedBy integer

ID de 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.

Name Caminho Tipo Description
ID
 id integer

Identificador exclusivo para o status.
Nome
 name string

Nome do status.
ID de Domínio
 domainId integer

Identificador de domínio para o status.
Referência da fonte
 sourceReference string

Referência à fonte do estatuto.
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.
É suprimido
 isDeleted boolean

Indica se o status é excluído.
ID do fluxo de trabalho
 workflowId integer

ID do fluxo de trabalho associado ao status.
Cor Vermelho
 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.
Position
 position integer

Posição do estatuto.

StatusRoutingUserClasses

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

Name Caminho Tipo Description
Status ID
 statusId integer

ID do status para 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.

Name Caminho Tipo Description
Status ID
 statusId integer

ID da transição de status.
Status de início do fluxo de trabalho
 workflowInitiatingStatus boolean

Indica se a transição é iniciada pelo fluxo de trabalho.
Próximo IDs de status possíveis
 nextPossibleStatusIds array of integer

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

Relação de ativos

Detalhes de uma relação entre ativos.

Name Caminho Tipo Description
ID
 id integer

ID exclusivo da relação de ativos.
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 de Relação
 relationState integer

Estado da relação.
Bloqueado para versão infantil
 lockedToChildVersion boolean

Sinalizador que indica se a relação está bloqueada para a versão filho.
Congelar para a versão atual
 freezeToCurrentVersion boolean

Sinalizador que indica 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.

Name Caminho Tipo Description
ID
 id integer

ID exclusivo do atributo.
Nome
 name string

Nome do atributo.
Tipo de valor
 valueType integer

Tipo de valor que o atributo retém.
Definido pelo Utilizador
 userDefined boolean

Indica se o atributo é definido pelo usuário.
Consultável
 queryable boolean

Indica se o atributo é consultável.
Multi Valorados
 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.
Exibivel
 displayable boolean

Indica se o atributo pode ser exibido.
Acesso limitado
 limitedAccess boolean

Indica se o atributo tem acesso limitado.
Acesso limitado mutável
 limitedAccessChangeable boolean

Indica se a configuração de acesso limitado pode ser alterada.
Restrições Mutá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 booleano
 booleanValuePreferences BooleanValuePreferences

Preferências para valores booleanos.
Preferências de valor numérico
 numericValuePreferences NumericValuePreferences

Preferências por 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 tempo
 timeValuePreferences TimeValuePreferences

Preferências para valores de tempo.
Preferências de valor de medição
 measurementValuePreferences MeasurementValuePreferences

Preferências para valores de medição.
Preferências de valor de texto
 textValuePreferences TextValuePreferences

Preferências para valores de texto.
Preferências da 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.

Name Caminho Tipo Description
ID
 id integer

ID exclusivo do atributo.
Nome
 name string

Nome do atributo.
Tipo de valor
 valueType integer

Tipo de valor que o atributo mantém 1 para tipo de texto, etc.
Definido pelo Utilizador
 userDefined boolean

Indica se o atributo é definido pelo usuário.
Consultável
 queryable boolean

Indica se o atributo é consultável.
Multi Valorados
 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.
Exibivel
 displayable boolean

Indica se o atributo pode ser exibido.
Acesso limitado
 limitedAccess boolean

Indica se o atributo tem acesso limitado.
Acesso limitado mutável
 limitedAccessChangeable boolean

Indica se a configuração de acesso limitado pode ser alterada.
Restrições Mutá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 booleano
 booleanValuePreferences BooleanValuePreferences

Preferências para valores booleanos.
Preferências de valor numérico
 numericValuePreferences NumericValuePreferences

Preferências por 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 tempo
 timeValuePreferences TimeValuePreferences

Preferências para valores de tempo.
Preferências de valor de medição
 measurementValuePreferences MeasurementValuePreferences

Preferências para valores de medição.
Preferências de valor de texto
 textValuePreferences TextValuePreferences

Preferências para valores de texto.
Preferências da 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.

Name Caminho Tipo Description
ID
 id integer

ID exclusivo do tipo de conteúdo.
Nome
 name string

Nome do tipo de conteúdo.
ID de Domínio
 domainId integer

ID de domínio associado ao tipo de conteúdo.
Referência da fonte
 sourceReference string

Referência à fonte 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.
É suprimido
 isDeleted boolean

Indica se o tipo de conteúdo foi excluído.
Sistema Definido
 systemDefined boolean

Indica se o tipo de conteúdo é definido pelo sistema.
Crianças disponíveis
 childrenAvailable boolean

Indica se as crianças 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 booleanos.

Name Caminho Tipo Description
Valor booleano
 defaultValue BooleanValue

Valor booleano.

BooleanValue

Valor booleano.

Name Caminho Tipo Description
Valor
 value boolean

O valor booleano.

NumericValuePreferences

Preferências por valores numéricos.

Name 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.

Valor numérico

Valor numérico.

Name Caminho Tipo Description
Valor
 value integer

O valor numérico.

DateValue

Valor da data.

Name Caminho Tipo Description
Valor
 value string

O valor da data.

DateValuePreferences

Preferências para valores de data.

Name 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.

Name Caminho Tipo Description
Valor
 value string

O valor DateTime.

DateTimeValuePreferences

Preferências para valores DateTime.

Name Caminho Tipo Description
Valor DateTime
 minimumPossibleValue DateTimeValue

Valor DateTime.
Valor DateTime
 maximumPossibleValue DateTimeValue

Valor DateTime.
Valor DateTime
 defaultValue DateTimeValue

Valor DateTime.

TimeValue

Valor do tempo.

Name Caminho Tipo Description
Valor
 value string

O valor de tempo.

TimeValuePreferences

Preferências para valores de tempo.

Name Caminho Tipo Description
Valor do tempo
 minimumPossibleValue TimeValue

Valor do tempo.
Valor do tempo
 maximumPossibleValue TimeValue

Valor do tempo.
Valor do tempo
 defaultValue TimeValue

Valor do tempo.

MeasurementValue

Valor de medição.

Name Caminho Tipo Description
Valor
 value double

O valor de medição.

MediçãoValorPreferências

Preferências para valores de medição.

Name Caminho Tipo Description
Unidade de medida
 measurementUnit integer

Unidade de medida.
Apenas unidade de medida mutável
 onlyMeasurementUnitChangeable boolean

Indica se apenas a unidade de medida é mutável.
Valor de medição
 minimumPossibleValue MeasurementValue

Valor de medição.
Valor de medição
 maximumPossibleValue MeasurementValue

Valor de medição.
Valor de medição
 defaultValue MeasurementValue

Valor de medição.

TextValue

Valor do texto

Name Caminho Tipo Description
Valor
 value string

O valor do texto.

TextValuePreferences

Preferências para valores de texto.

Name 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 do texto.
Pesquisa de texto ativada
 textSearchEnabled boolean

Indica se a pesquisa de texto está ativada.

DomainValueList

Lista de valores de domínio.

Name 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.

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

Lista de valores de domínio.
ID de Domínio
 domainId integer

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

DomainValuePreferences

Preferências para valores de domínio.

Name Caminho Tipo Description
defaultValue
 defaultValue DomainValue
ID de Domínio
 domainId integer

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

QueryDefinition

Definição de uma consulta.

Name Caminho Tipo Description
ID da consulta
 queryId integer

ID exclusivo da consulta.
Nome da consulta
 queryName string

Nome da consulta.
ID do Proprietário
 ownerId integer

ID do proprietário da consulta.
Parametrizado
 parameterized boolean

Indica se a consulta está parametrizada.
Exibição de consultas
 queryDisplay QueryDisplay

Exibir configurações para uma consulta.
Condições de Consulta
 queryConditions array of QueryCondition

Lista de condições de consulta.
Contexto da consulta
 queryContext QueryContext

Configurações de contexto para uma consulta.
queryResultados
 queryResults

QueryDisplay

Exibir configurações para uma consulta.

Name 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 Visualização
 displayMode integer

Configuração do modo de exibição.
Agrupando atributos
 groupingAttributes array of GroupingInfo

Lista de atributos de agrupamento.
Modo de Exploração
 exploreMode integer

Explorar a configuração do modo.

QueryCondition

Condição para uma consulta.

Name 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 é negada.
Parametrizado
 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 para pesquisar contra
 value string

valor para Procurar contra.

QueryContext

Configurações de contexto para uma consulta.

Name 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 filiais
 includeBranches boolean

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

DisplayColumn

Coluna para exibição em uma consulta.

Name Caminho Tipo Description
ID da coluna
 columnId integer

ID da coluna de exibição.
Largura
 width integer

Largura da coluna de visualização.
Coluna de atributos
 attributeColumn boolean

Indica se a coluna é uma coluna de atributo.

SortInfo

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

Name Caminho Tipo Description
ID da coluna
 columnId integer

ID da coluna para classificação.
Descending
 descending boolean

Indica se a classificação está em ordem decrescente.
Coluna de atributos
 attributeColumn boolean

Indica se a coluna classificada é uma coluna de atributo.

GroupingInfo

Agrupamento de configurações para uma consulta.

Name Caminho Tipo Description
ID do atributo
 attributeId integer

ID do atributo para agrupamento.
Descending
 descending boolean

Indica se o agrupamento está em ordem decrescente.

ListResponseQueryResultElement

Elemento de resposta para listar os resultados da consulta.

Name Caminho Tipo Description
Contar
 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.
Valor
 get_value array of QueryResultElement

Matriz de elementos de resultado de consulta.

QueryResultElement

Elemento em um resultado de consulta.

Name Caminho Tipo Description
ID
 id integer

Identificador exclusivo para o elemento.
Criança 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.

Name Caminho Tipo Description
Contar
 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.
Valor
 get_value array of User

Matriz de elementos do usuário.

PublishingStatusInfo

Name Caminho Tipo Description
PublishingFailedException
 publishingFailedException PublishingFailedException

Exceção lançada quando a publicação falha
publicandoOutputDownloadInfo
 publishingOutputDownloadInfo array of PublishingOutputDownloadInfo
Status de publicação
 publishingStatus string

Status de publicação do ativo, Valores de retorno possíveis são PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED

PublishingFailedException

Exceção lançada quando a publicação falha

Name Caminho Tipo Description
Informação Adicional
 additionalInfo array of string

Informações adicionais relacionadas com a exceção
Arremessável
 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 descrevendo a exceção
Message
 message string

Mensagem descrevendo a exceção
stackTrace
 stackTrace array of StackTraceElement
suprimido
 suppressed array of Throwable

Arremessável

Classe base para exceções e erros

Name Caminho Tipo Description
Motivo
 cause string

A causa do arremessável
Mensagem localizada
 localizedMessage string

Mensagem localizada descrevendo o throwable
Message
 message string

Mensagem descrevendo o lance
stackTrace
 stackTrace array of StackTraceElement
Suprimido
 suppressed array of string

Outros arremessáveis suprimidos por este arremessável

StackTraceElement

Um elemento que representa um único quadro de pilha

Name 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 ficheiro que contém o ponto de execução
Número da linha
 lineNumber integer

Número de linha no ficheiro 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

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

O ID de classe de usuário padrão para o grupo.
Suprimido
 deleted boolean

Indica se o grupo é excluído.
ID de Domínio
 domainId integer

A ID do domínio ao qual o grupo pertence.
Endereço de E-mail
 emailAddress string

O endereço de e-mail associado ao grupo.
Tem filhos
 hasChildren boolean

Indica se o grupo tem filhos.
ID
 id integer

A ID do grupo.
É suprimido
 isDeleted boolean

Indica se o grupo é excluído.
Nome distinto LDAP
 ldapDistinguishedName string

O nome distinto no LDAP para o grupo.
ID do perfil LDAP
 ldapProfileId integer

O 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.
Administrador nativo
 nativeTrustee boolean

Indica se o grupo é um administrador nativo.
Referência da fonte
 sourceReference string

A referência de origem para o grupo.
User
 user boolean

Indica se o grupo é um usuário.

número inteiro

Este é o tipo de dados básico 'inteiro'.

cadeia (de caracteres)

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