Partilhar via


HighQ (Pré-visualização)

Esse conector permite acesso seguro e autenticado a APIs HighQ, permitindo a integração perfeita de recursos de colaboração e gerenciamento de conteúdo em fluxos de trabalho e aplicativos personalizados. Ele suporta automação de documentos, sincronização de dados e orquestração de fluxo de trabalho — capacitando as equipes de serviços jurídicos e profissionais para simplificar as operações, reduzir o esforço manual e aumentar a produtividade.

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 Highq
URL https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email highq-support@thomsonreuters.com
Metadados do conector
Editora Thomson Reuters Incorporada
Sítio Web https://legal.thomsonreuters.com/en/products/highq
Política de privacidade https://www.thomsonreuters.com/en/privacy-statement
Categorias Colaboração; Conteúdo e Ficheiros

HighQ

Visão geral

O HighQ fornece acesso autenticado, seguro e contínuo às APIs do HighQ. Esse conector permite a interação perfeita com vários serviços HighQ, incluindo o Módulo ISheet, APIs de Recursos de Documentos, API de Administração de ISheet e operações de Usuário. Ele foi projetado para facilitar a integração com a plataforma HighQ Collaborate, oferecendo funcionalidades como recuperar e criar itens do iSheet, gerenciar arquivos de documentos e administrar contas de usuário.

  • Versão do conector: 1.0.0
  • Designação: HighQ
  • Descrição: Este conector oferece acesso contínuo, seguro e autenticado às APIs HighQ.
  • Contato:
    • Designação: Highq
    • Website:Suporte HighQ
    • Email:highq-support@thomsonreuters.com

Authentication

O conector aproveita variáveis de ambiente dinâmico para conectividade segura:

  • Anfitrião: @environmentVariables("highqt_host")
  • Caminho base: /@environmentVariables("highqt_instancename")/api
  • ID do cliente:@environmentVariables("highqt_clientid")
  • Segredo do cliente:@environmentVariables("highqt_clientsecret")

Para obter procedimentos de autenticação detalhados, consulte o portal de suporte técnico HighQ ou entre em contato com o suporte HighQ.

Operações do conector

Módulo ISheet

  • Recuperar itens do iSheet
    GET /{version}/isheet/{isheetid}/items
    Recupera uma lista de itens dentro do iSheet especificado.

  • Criar itens do iSheet
    POST /{version}/isheet/{isheetid}/items
    Insere novos itens num iSheet, com suporte para vários iSheets e acompanhamento de estado através de teclas progressivas.

APIs de recursos de documentos

  • Recuperar informações do arquivo
    GET /{version}/files/{fileid}
    Recupera informações detalhadas sobre um arquivo específico na plataforma HighQ Collaborate.

  • Carregar um ficheiro
    POST /{version}/files/content
    Carrega um arquivo para uma pasta especificada, suportando carregamentos em partes quando o Content-Range cabeçalho é fornecido.

  • Recuperar Lista de Pastas
    GET /{version}/folders/{folderid}/items
    Recupera uma lista de pastas dentro da pasta especificada com suporte para classificação e paginação.

API de administração do ISheet

  • Recuperar colunas do iSheet
    GET /{version}/isheets/admin/{isheetid}/columns
    Recupera configurações de coluna para um determinado iSheet.

Operações do usuário

  • Recuperar usuários
    GET /{version}/users
    Recupera uma lista de usuários com suporte para filtragem, paginação e funções de usuário detalhadas.

  • Adicionar um novo usuário
    POST /{version}/users
    Cria uma nova conta de usuário com atributos estendidos e validação.

  • Arquivar um usuário
    DELETE /{version}/users/{userid}
    Arquiva um usuário existente do sistema.

Gestão de Documentos e Site

  • Criar uma pasta
    POST /{version}/folders
    Cria uma nova pasta em uma pasta pai especificada.

  • Mover documentos
    PUT /{version}/files/move
    Move um ou vários arquivos de uma pasta para outra dentro do mesmo site.

  • Operações de Gestão do Site:

    • Adicionar grupo existente ao site: POST /{version}/sites/{siteid}/groups/{groupid}
    • Atualizar Grupo de Sites: PUT /{version}/sites/{siteid}/groups/{groupid}
    • Adicionar um novo site: POST /{version}/sites

Introdução

  1. Configuração:

    • Defina as variáveis highqt_host de ambiente e highqt_instancename no seu ambiente Power Platform.
  2. Authentication: (Autenticação)

    • Siga as diretrizes fornecidas pelo HighQ para configurar a autenticação segura para solicitações de API.
  3. Utilização:

    • Importe o HighQ para sua instância do Power Platform.
    • Utilize as operações disponíveis conforme necessário. Consulte os resumos das operações fornecidos acima para obter orientações.

Parâmetros e configurações

  • Parâmetros do caminho:
    Inclua os parâmetros necessários, como version, isheetid, fileid, folderide userid conforme aplicável.

  • Parâmetros de consulta:
    Parâmetros opcionais como sheetviewid, sortcolumnid, limit, e offset estão disponíveis para refinar as respostas da API.

  • Parâmetros do corpo:
    Para operações que exigem um corpo de solicitação (por exemplo, criação de itens ou usuários do iSheet), verifique se a solicitação está de acordo com os esquemas definidos (como isheetDBO, FolderDBOou IntegrationUserDBO).

Solução de problemas e limitações

  • Códigos de erro:
    Os códigos de status HTTP padrão são usados em todas as operações:

    • 200 para operações bem-sucedidas
    • 401 para acesso não autorizado
    • 403 por falhas proibidas ou de validação
    • 405 para métodos HTTP inválidos
    • 500 para erros internos do servidor
      Consulte a documentação individual da API para obter descrições detalhadas dos erros.
  • Limitações:
    Alguns pontos de extremidade podem ter limites padrão (por exemplo, um padrão limit de 100 registros). Parâmetros adicionais podem ser necessários para classificar e filtrar grandes conjuntos de dados.

Recursos adicionais

Para obter informações mais detalhadas e documentação alargada, consulte:

Licenciamento e Suporte

Para obter detalhes de licenciamento e suporte técnico:

Limites de Limitação

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

Ações

Adicionar grupo existente ao site

Este método de API adiciona um grupo de sistema existente ao site.
Esta API foi estendida para adicionar grupos de usuários básicos do sistema existentes (do tipo sistema / organização) no site.

Adicionar site

Use esta API para criar um novo site. O objeto de site suporta apenas atributos que são visíveis na interface de criação do site.

Essa API requer o nome do site (e campos obrigatórios configurados no nível ASP, se houver) para criar um novo site.

A tag "module" representa um módulo diferente para configurar no site, como é mostrado nos atributos de solicitação.
Para criar site a partir do modelo passando a tag "sitetemplateid"
     - Para menos de versão 7, Se algum módulo não for dado ("module" tag não é passado) na solicitação, a configuração do módulo de modelo ocorrerá. Se a tag de módulo for fornecida com configuração, ela respeitará isso e configurará conforme indicado na solicitação (em vez de utilizar a configuração do módulo de modelo)
     - Para maior que a versão 7, Se algum módulo for dado ("module" tag for passado) ou não na solicitação, a configuração do módulo de modelo ocorrerá.

Este método não suporta o carregamento de imagens do site nesta chamada, o suporte ao ícone do site será fornecido como uma chamada separada.
A chamada de método espera um ID de categoria existente. O ID da categoria deve ser obtido pelo aplicativo chamador por uma chamada anterior para a interface de categorias do site. Se nenhuma categoria for dada na solicitação, nenhuma categoria (nem nenhuma categoria real) será adicionada por padrão.

As datas de início e fim do site devem estar no formato 'dd MMM aa' e NÃO é UTC. O cliente da API sempre solicitará a data real.

"LandingPage" tem valor padrão como "Files (Root Folder)".
"landingpage" espera três palavras ou identificações diferentes para o módulo File. Os valores possíveis são:
- arquivos (pasta raiz)
- arquivos (atividade recente)
- ficheiros (pesquisa avançada)
A implementação do método agora suporta (a partir da versão 5.1) o nome do site multilíngue. O nome< do site da API versão 6 ou superior >será representado no corpo da solicitação com base na ordem de preferências do usuário. A API versão 5 ou o nome< do site mais antigo >representará o inglês padrão do Reino Unido.
<sitenametranslations> representará sitenames em todos os idiomas (que será tag adicional em "Object itself API" a partir de 5.1) API versão 6 ou superior, no corpo da solicitação, Eles estão enviando ambas as tags ou seja <, sitename> e <sitenametranslations> então precisamos validar valores, por exemplo, <sitename> deve corresponder com a respetiva <tag de tradução> em termos de preferência de idioma do usuário. API 7 ou superior, o site criado a partir do modelo seguirá os módulos do modelo de origem e ignorará a lista de módulos enviada no corpo da solicitação.

A implementação do método agora suporta criar site a partir do modelo, fornecendo a tag "sitetemplateid" (abordagem antiga)

Observe que o suporte para a criação de site a partir do modelo usando esta API será preterido no futuro. Para criar site a partir do modelo, use a nova API Criar site a partir do modelo (/sites/templates/{templateid}/site), que é uma API de sondagem longa (com suporte para solicitações de longa duração)

Este método suporta vários números de matéria para adicionar ao site usando a API versão 10 em diante. A tag "matternos" indica vários números de matéria com somente leitura ou não. A versão mais antiga (menos que a versão 10) número de matéria única "matterno" refletirá o primeiro número de matéria de vários números de matéria existentes no local.

Versão 18 em diante: é necessária uma categoria (finalidade do site). Se a finalidade do site estiver oculta, uma mensagem será exibida; caso contrário, as finalidades ocultas do site não serão adicionadas ao site.

Até à versão 17: o proprietário do site é o utilizador com sessão iniciada; nenhum outro usuário pode ser adicionado.

Versão 18 em diante: o proprietário do site pode adicionar outros usuários ao site.

A partir da versão 19 da API, é introduzido um novo módulo chamado 'customPages', que está fortemente acoplado ao módulo home. Assim, se o valor do módulo inicial for True, customPages será true e vice-versa.

Adicionar utilizador

Esta chamada de API é usada para adicionar um novo usuário ao sistema.
Nota:
1. Adicionado suporte para os seguintes novos campos
emaildomain, org, invitationsent, createdby, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. A tag de endereço foi adicionada na API versão 4

1

Resumo Código Ref (antes de V4) Código Ref (V4)

O endereço de e-mail é obrigatório

101 101

Endereço de e-mail inválido

104 104

O nome próprio é obrigatório

102 102

O máximo de caracteres permitidos para o primeiro nome deve estar entre 1 e 100

102 352

O endereço de e-mail da secretária/assistente não é válido

104 353

O status deve estar ativo ou inativo

116 116

O departamento inserido não pode ter mais de 256 caracteres

N/A 354

O atributo ifpartner inserido é inválido

N/A 355

O atributo systemuser inserido é inválido

N/A 356

O atributo usertypeid inserido é inválido

N/A 357

O atributo langcode inserido é inválido

N/A 358

O atributo sourcetype inserido é inválido. Os valores válidos são System, Ative directory ou System default .

N/A 359

Introduza um número de telefone válido   

N/A 360

Introduza um número de telefone válido no formato {countrycode}  ${areacode}${number}.

N/A 361

Introduza um número de telemóvel válido no formato {countrycode}${number}.

N/A 362

Insira um código de país de telefone de escritório válido

N/A 363

O código de país do telefone do escritório pode ter um máximo de 4 dígitos

N/A 364

Insira um código de área de telefone de escritório válido

N/A 365

O código de área do telefone do escritório pode ter um máximo de 5 dígitos

N/A 366

O número de telefone do escritório deve ter no máximo 15 dígitos

N/A 368

Introduza um código de país de telemóvel válido

N/A 369

O código de país do telemóvel pode ter um máximo de 4 dígitos

N/A 372

Introduza um número de telemóvel válido

N/A 373

Número de telemóvel deve ter no máximo 20 dígitos

N/A 374

O domínio não existe

105 105

O email já existe no sistema

111 111

Mencionar organização no caso de domínio auto-registado   

187 187

Mencionar organização em caso de domínio excecional   

115 115

O ID da organização não está no formato adequado   

112 112

Organização não existe

106 106

Domínio existe noutra organização

114 114

O ID de endereço inserido não é válido

N/A 308

Nome do link social não encontrado no sistema.

N/A 375

O nome do link social é obrigatório

N/A 376

O valor do link social é necessário

N/A 377

O máximo de caracteres para o valor do link social deve estar entre 1 e 500

N/A 378

Insira o nome do link personalizado

N/A 379

O valor de link personalizado necessário

N/A 380

O máximo de caracteres para o nome do link personalizado deve estar entre 1 e 500

N/A 381

O máximo de caracteres para o valor do link personalizado deve estar entre 1 e 500

N/A 382

O nome do link da mensagem necessário

N/A 383

Nome do link da mensagem não encontrado no sistema

N/A 384

O valor do link da mensagem necessário   

N/A 385

O máximo de caracteres para o valor do link de mensagem deve estar entre 1 e 500

N/A 386

O link social está desativado

N/A 408

O link da mensagem está desativado

N/A 409

O link personalizado está desativado

N/A 410

Bilhete JIRA : https://dev.highq.com/jira/browse/COL-65685

Arquivar Utilizador

Esta chamada de API é usada para arquivar um usuário dentro do sistema.

Códigos de erro

Resumo Código Ref (antes de V4) Código Ref (V4)

Os seguintes usuários não existem dentro do sistema:

110 110

É necessário um ID de utilizador

109 109

 ID de usuário não está no formato adequado

113 113

O comprimento do ID do usuário não pode exceder 50 caracteres

N/A 304


Bilhete JIRA : https://dev.highq.com/jira/browse/COL-67441

Atualizar grupo de sites

Esse método de API atualiza o nome de um grupo existente em um site.
Essa API foi estendida para atualizar o nome de um grupo de usuários básicos existente em um site.

Atualizar site

Use este ponto de extremidade da API para atualizar os detalhes de um site existente. A API suporta os mesmos campos usados em Criar API de site.

Este método suporta vários números de matéria para adicionar ao site usando a API versão 10 em diante. A tag "matternos" indica vários números de matéria com somente leitura ou não.

Versão 18 em diante: é necessária uma categoria (finalidade do site). Se a finalidade do site estiver oculta, uma mensagem será exibida; caso contrário, as finalidades ocultas do site não serão adicionadas ao site.

Agora, o proprietário do site também pode receber outros usuários, mas eles devem ser participantes do site e ter uma função superior à de administrador do site.

Versão 18 em diante: o proprietário do site pode adicionar outros usuários ao site.

A partir da API versão 19, um novo módulo chamado customPages é introduzido, que é fortemente acoplado ao módulo home. Se o valor do módulo inicial for True, customPages terá que ser true e vice-versa.

Observe que todas as propriedades/elementos em obter resposta do site não são atualizáveis/inseríveis. Veja a tabela abaixo para saber quais são somente leitura, atualizáveis ou inseríveis.

Carregar um ficheiro

Esta chamada de API carrega um arquivo para uma pasta especificada na plataforma HighQ Collaborate. Ele suporta uploads em partes quando o cabeçalho Content-Range é fornecido.

Criar pasta

Esta API cria uma nova pasta dentro do site especificado. Ele permite que você forneça detalhes da pasta e garante que a pasta seja criada sob a pasta pai fornecida.

Mover documentos

Essa API move vários arquivos de uma pasta para outra dentro do mesmo site.

Obter informações da pasta

O método fornece detalhes da pasta de determinada ID de pasta.

Para criar o item do iSheet

Esta chamada de API é usada para inserir o item do iSheet. Vários iSheets podem ser suportados.

Para obter o status de um item do iSheet com base em uma chave progressiva, chame API POST /api/3/progressivekeystatus/{progressive_key}

por exemplo, POST /api/{version}/progressivekeystatus/{progressive_key}

NomeTipoDescription
progressive_keyCordão Chave para verificar o status da sua ação.

Resposta

<ProgressiveKeyResponse>
 \t<itens>
  \t\t<item>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<mensagem>Registro adicionado com êxito</mensagem>
  \t\t</item>
  \t\t<item>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<mensagem>Registro adicionado com êxito</mensagem>
  \t\t</item>
 \t</itens>
</progressivekeyresponse>
Recuperar colunas do iSheet

Esta chamada de API recupera as colunas associadas ao iSheet especificado. Esta funcionalidade é suportada na API versão 3 e superior.

Recuperar informações do arquivo

Esta chamada de API recupera informações detalhadas para um arquivo especificado da plataforma HighQ Collaborate.

Recuperar lista de usuários

Recuperar uma lista de usuários Esta API recupera uma lista de usuários do sistema. ## Principais Características - Buscar detalhes do usuário com várias opções de filtragem - Suporta paginação com limit e offset - Novos parâmetros de consulta e campos introduzidos em versões recentes - Resposta estruturada com funções e atributos de usuário ## Novos parâmetros de consulta (Version-Specific) - Introduzido na V12: - systemAdminSearch: Quando definido como 1, só retorna usuários com a função de administrador do sistema. - Introduzido na V18: - userid: Aceita valores separados por vírgulas (CSV). ## Response Body Updates - Novos campos adicionados: - emaildomain, org, invitationsent, createdby,createddatemodifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcodepublicprofiledateOfBirth## Address Format Change (from V11) - A location tag foi renomeada para address consistência . - Exemplo de resposta: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## Funções de usuário (introduzido na API v11+) - Exemplo de resposta: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## Limites & Compensações - Comportamento de limite: - Padrão: 100 se nenhum valor for fornecido. - Use -1 para retornar todos os registros. - Se o valor for menor que , o padrão será -1.100 - Comportamento de deslocamento: - Padrão: 0 se nenhum valor for fornecido. - Se o deslocamento exceder o total de registros, o padrão voltará para 0. ## Novas funções introduzidas - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Códigos de erro | Resumo | Código Ref (Antes V4) | Código Ref (V4) | |---------|----------------------|--------------| | Entrada inválida para o status do usuário (ATIVO, ARQUIVADO, INATIVO) | Artigo 147.º | Artigo 147.º | | O ID da organização é inválido | N/A | 260 | | Valor inválido neverinvited (true/false) | N/A | 387 | | Valor inválido neverlogin (true/false) | N/A | 388 | | Valor inválido groupids | N/A | 214 | | Valor inválido notingroup (true/false) | N/A | 389 | | Inválido ordertype (suportado: nome, organização, estado, etc.) | N/A | 289 | | Inválido orderby (suportado: asc, desc) | N/A | 290 | | Valor inválido offset | 138 | 138 | | Valor inválido limit | 137 | 137 | ## Notas - A partir da V13, esta API está aberta para todos os utilizadores (anteriormente limitada a administradores de sistema). - A partir da V18, o userregistered2FA campo indica se um utilizador se registou no 2FA. --- Esta descrição segue a formatação do esquema Swagger 2.0 e deve ser colocada no campo de descrição no esquema do Conector Personalizado.

Recuperar uma lista de itens do iSheet

Esta chamada de API recupera uma lista de itens contidos no iSheet especificado.

Recuperar uma lista de pastas

Esta chamada de API recupera uma lista de pastas contidas na pasta especificada. O parâmetro 'limit' define o número máximo de itens a retornar e o parâmetro 'offset' especifica a posição inicial para a recuperação de dados. Os valores padrão são aplicados se esses parâmetros forem omitidos e as pastas forem retornadas em ordem crescente por data de criação.

Adicionar grupo existente ao site

Este método de API adiciona um grupo de sistema existente ao site.
Esta API foi estendida para adicionar grupos de usuários básicos do sistema existentes (do tipo sistema / organização) no site.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

versão

O ID do site
siteid True string

O ID do site.

A ID do grupo de sistemas
groupid True string

A ID do grupo de sistemas a ser adicionado ao site.

Devoluções

Body
sitegroup

Adicionar site

Use esta API para criar um novo site. O objeto de site suporta apenas atributos que são visíveis na interface de criação do site.

Essa API requer o nome do site (e campos obrigatórios configurados no nível ASP, se houver) para criar um novo site.

A tag "module" representa um módulo diferente para configurar no site, como é mostrado nos atributos de solicitação.
Para criar site a partir do modelo passando a tag "sitetemplateid"
     - Para menos de versão 7, Se algum módulo não for dado ("module" tag não é passado) na solicitação, a configuração do módulo de modelo ocorrerá. Se a tag de módulo for fornecida com configuração, ela respeitará isso e configurará conforme indicado na solicitação (em vez de utilizar a configuração do módulo de modelo)
     - Para maior que a versão 7, Se algum módulo for dado ("module" tag for passado) ou não na solicitação, a configuração do módulo de modelo ocorrerá.

Este método não suporta o carregamento de imagens do site nesta chamada, o suporte ao ícone do site será fornecido como uma chamada separada.
A chamada de método espera um ID de categoria existente. O ID da categoria deve ser obtido pelo aplicativo chamador por uma chamada anterior para a interface de categorias do site. Se nenhuma categoria for dada na solicitação, nenhuma categoria (nem nenhuma categoria real) será adicionada por padrão.

As datas de início e fim do site devem estar no formato 'dd MMM aa' e NÃO é UTC. O cliente da API sempre solicitará a data real.

"LandingPage" tem valor padrão como "Files (Root Folder)".
"landingpage" espera três palavras ou identificações diferentes para o módulo File. Os valores possíveis são:
- arquivos (pasta raiz)
- arquivos (atividade recente)
- ficheiros (pesquisa avançada)
A implementação do método agora suporta (a partir da versão 5.1) o nome do site multilíngue. O nome< do site da API versão 6 ou superior >será representado no corpo da solicitação com base na ordem de preferências do usuário. A API versão 5 ou o nome< do site mais antigo >representará o inglês padrão do Reino Unido.
<sitenametranslations> representará sitenames em todos os idiomas (que será tag adicional em "Object itself API" a partir de 5.1) API versão 6 ou superior, no corpo da solicitação, Eles estão enviando ambas as tags ou seja <, sitename> e <sitenametranslations> então precisamos validar valores, por exemplo, <sitename> deve corresponder com a respetiva <tag de tradução> em termos de preferência de idioma do usuário. API 7 ou superior, o site criado a partir do modelo seguirá os módulos do modelo de origem e ignorará a lista de módulos enviada no corpo da solicitação.

A implementação do método agora suporta criar site a partir do modelo, fornecendo a tag "sitetemplateid" (abordagem antiga)

Observe que o suporte para a criação de site a partir do modelo usando esta API será preterido no futuro. Para criar site a partir do modelo, use a nova API Criar site a partir do modelo (/sites/templates/{templateid}/site), que é uma API de sondagem longa (com suporte para solicitações de longa duração)

Este método suporta vários números de matéria para adicionar ao site usando a API versão 10 em diante. A tag "matternos" indica vários números de matéria com somente leitura ou não. A versão mais antiga (menos que a versão 10) número de matéria única "matterno" refletirá o primeiro número de matéria de vários números de matéria existentes no local.

Versão 18 em diante: é necessária uma categoria (finalidade do site). Se a finalidade do site estiver oculta, uma mensagem será exibida; caso contrário, as finalidades ocultas do site não serão adicionadas ao site.

Até à versão 17: o proprietário do site é o utilizador com sessão iniciada; nenhum outro usuário pode ser adicionado.

Versão 18 em diante: o proprietário do site pode adicionar outros usuários ao site.

A partir da versão 19 da API, é introduzido um novo módulo chamado 'customPages', que está fortemente acoplado ao módulo home. Assim, se o valor do módulo inicial for True, customPages será true e vice-versa.

Parâmetros

Name Chave Necessário Tipo Description
A versão da API que está sendo solicitada
version True string

Versão da API

id
id integer

O identificador do site.

nome do site
sitename string

O nome do site.

função
role string

O papel do site.

Descrição do site
sitedescription string

A descrição do site.

módulos habilitados
enabledmodules string

Uma lista de módulos habilitados para o site.

sitefolderID
sitefolderID string

O identificador da pasta do site.

sitefolderpermission
sitefolderpermission string

O nível de permissão para a pasta do site.

activar
enable string

Habilite o status para HomeDBO.

activar
enable string

Habilite o status para ActivityDBO.

microblog
microblog string

Conteúdo de microblog associado ao ActivityDBO.

Docid
docid string

ID do documento.

blogTítulo
blogTitle string

Título da postagem do blog.

blogConteúdo
blogContent string

Conteúdo da postagem do blog.

showComment
showComment integer

mostrar o comentário.

tagLista
tagList array of string

Lista de tags associadas ao blog.

estado
status integer

status da postagem do blog.

ID do site
siteID integer

Identificador do site associado.

autor
author string

Autor do blog.

categoryList
categoryList array of string

Categorias atribuídas à postagem do blog.

notificationTypeID
notificationTypeID integer

Identificador do tipo de notificação.

mensagem
message string

Conteúdo da mensagem relacionado ao blog.

Código da mensagem
messageCode integer

Código associado à mensagem.

ID externo
externalID string

Identificador externo vinculado ao blog.

publicarData
publishDate string

Data de publicação do blog.

tipo de processo
processtype string

Tipo de processo associado ao blog.

activar
enable string

Habilite o status para BlogDBO.

Wikiid
wikiid integer

Identificador exclusivo para o wiki.

CurrentVersionID
currentversionid integer

Identificador da versão atual do wiki

parentwikiid
parentwikiid integer

Identificador do wiki pai.

título wiki
wikititle string

Título da wiki.

conteúdo wiki
wikicontent string

Conteúdo da wiki.

showcomment
showcomment integer

Indicando se os comentários estão habilitados.

data de criação
createddate string

Data de criação da wiki.

data modificada
modifieddate string

Data da última modificação da wiki.

Lista de tags
taglist string

Lista separada por vírgulas de tags associadas ao wiki.

Wikicaminho
wikipath string

Caminho para acessar o wiki.

WikiDraftID
wikidraftid integer

Identificador da versão preliminar do wiki.

Tipo de rascunho
drafttype string

Tipo de rascunho associado ao wiki.

estado
status integer

Status atual do wiki.

WikiVersionID
wikiversionid integer

Identificador de versão do wiki.

indexar
index string

Índice ou identificador da tarefa.

ParentTaskID
parenttaskid integer

Identificador da tarefa pai.

TaskID
taskid integer

Identificador exclusivo da tarefa.

title
title string

Título da tarefa.

descrição
description string

Descrição detalhada da tarefa.

Data de vencimento
duedate string

Data de conclusão da tarefa.

data de início
startdate string

Data de início em que a tarefa foi iniciada.

MatterMapTaskID
mattermaptaskid string

Identificador vinculado à tarefa de mapa de matéria.

tipo
type string

Tipo ou categoria da tarefa.

dependente
dependenton string

Tarefas das quais esta tarefa depende.

diasdedependentes
daysfromdependent string

Número de dias da tarefa dependente.

ignorarfim de semana
ignoreweekend integer

Indica se os fins de semana são ignorados na programação.

duration
duration integer

Duração para concluir a tarefa.

recurso
resource string

Recursos atribuídos à tarefa.

eventoTítulo
eventTitle string

Título do evento.

eventoConteúdo
eventContent string

Conteúdo do evento.

showComment
showComment integer

Indicando se os comentários estão habilitados para o evento.

tagLista
tagList array of string

Lista de tags associadas ao evento.

estado
status integer

Estado atual do evento.

ID do site
siteID integer

Identificador do site.

contacto
contact string

Informações de contacto para o evento.

categoryList
categoryList array of string

Categorias sob as quais o evento está listado.

notificationTypeID
notificationTypeID integer

O tipo de notificação relacionado ao evento.

mensagem
message string

A mensagem do evento.

Código da mensagem
messageCode integer

O código da mensagem do evento.

ID externo
externalID string

O identificador externo.

startDate
startDate string

A data de início do evento.

data de término
endDate string

A data final do evento.

startTime
startTime string

A hora de início do evento.

endTime
endTime string

A hora de término do evento.

localização
location string

O local do evento.

autor
author string

O autor do evento.

tipo de processo
processtype string

O tempo de processo do evento.

activar
enable string

Habilitar o evento.

id
id integer

Identificador exclusivo do iSheet.

title
title string

Título do iSheet.

descrição
description string

Descrição do isheet.

estado
status string

Estado do isheet.

tipo de acesso
accesstype string

Tipo de acesso do isheet.

tipo
type string

Tipo de isheet.

Ver link
viewlink string

Link para visualizar o iSheet.

allowsections
allowsections string

Se as seções são permitidas.

PermitirPesquisa
allowlookup string

Se os campos de pesquisa estão habilitados.

displayisheet
displayisheet string

Opções de exibição para o iSheet.

SearchAsDefaultView
searchasdefaultview string

Indica se a pesquisa é o modo de exibição padrão.

enableversion
enableversion string

Sinalizador de controle de versão habilitado.

EnableSheetAlerter
enablesheetalerter string

Sinalizador para ativar alertas de folha.

alertercondition
alertercondition string

Condições para acionar alertas.

OverrideItemModifiedDate
overrideitemmodifieddate string

Substituir sinalizador de data modificado.

EnableBulkInsertUpdate
enablebulkinsertupdate string

Habilite a inserção/atualização em massa.

descrições de campo
fielddescriptions string

Descrições de campos para o iSheet.

EnableRowLocking
enablerowlocking string

Habilite o bloqueio em nível de linha.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Truncar sinalizador de texto de várias linhas.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Limite de caracteres para truncamento de várias linhas.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Permitir a reutilização dos valores da lista de opções.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Permitir a reutilização dos valores da lista de pontuações.

allowIsheetComentários
allowIsheetComments string

Permitir comentários no iSheet.

shareRecordsLimit
shareRecordsLimit integer

Limite de registos permitidos a partilhar.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Limite de compartilhamento de registros habilitado.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Habilite o compartilhamento de formulários para adicionar registros.

contagem de recordes
recordcount string

Contagem recorde atual.

sheettypeid
sheettypeid integer

ID do tipo do iSheet

activar
enable string

Habilite a funcionalidade de controle de qualidade.

ID de usuário
userid integer

ID de Utilizador.

e-mail
email string

endereço de e-mail.

httpavatar
httpavatar string

URL HTTP do avatar.

Avatar
avatar string

Imagem do avatar.

link de usuário
userlink string

Link para o perfil do usuário.

Ligação http
httplink string

Link HTTP para o perfil do usuário.

phone
phone string

Número de telefone.

móvel
mobile string

Número de telemóvel.

departamento
department string

Departamento do utilizador.

activar
enable string

Habilite a integração do Contract Express.

nota de administrador
adminnote string

Notas administrativas relacionadas com o site.

data de início
startdate string

A data de início da operação do site.

Data de fim
enddate string

A data final do funcionamento do site.

data de criação
createddate string

A data em que o site foi criado.

data de arquivo
archiveddate string

A data em que o site foi arquivado.

clienteno
clientno string

O número de cliente associado ao site.

não importa
matterno string

O número da matéria associada ao site.

página de aterragem
landingpage string

O URL da página de destino do site.

ligação
link string

Um link relacionado ao site.

estado
status string

O status atual do site.

StatusID
statusid integer

O identificador do status do site.

size
size string

O tamanho do site.

notas de faturação
billingnotes string

Notas relacionadas com a faturação do site.

faturamentopróximodata da fatura
billingnextinvoicedate string

A data da próxima fatura do site.

billinglastinvoicedate
billinglastinvoicedate string

A data da última fatura do site.

FilePageCount
filepagecount string

A contagem total de páginas de arquivos no site.

MaxPageCount
maxpagecount string

A contagem máxima de páginas permitida para arquivos no site.

sítiohttplink
sitehttplink string

O link HTTP para o site.

isSyncable
isSyncable integer

Indica se o site é sincronizável.

EnforceUserGroups
enforceusergroups string

Os grupos de usuários impostos para o site.

csvSiteCategory
csvSiteCategory string

A categoria do site em formato CSV.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

O nome do site no idioma padrão.

visível
visible integer

Indica se o site está visível.

siteLogoName
siteLogoName string

O nome do arquivo de logotipo do site.

siteLogoFileSize
siteLogoFileSize integer

O tamanho do arquivo do logotipo do site.

siteLogoHeight
siteLogoHeight integer

A altura do logotipo do site.

siteLogoWidth
siteLogoWidth integer

A largura do logotipo do site.

Estado do site
siteStatus integer

O código de status do site.

applyTermos do Site
applySiteTerms integer

Indica se os termos do site são aplicados.

siteTerm
siteTerm string

Os termos aplicam-se ao site.

termType
termType integer

O tipo de termos aplicados ao site.

nextLoginSiteTermos
nextLoginSiteTerms integer

Indica se os termos do site são necessários no próximo login.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

Indica se os termos padrão do site estão habilitados.

advancedQAPermission
advancedQAPermission integer

O nível de permissão de QA avançado para o site.

isInterno
isInternal integer

Indica se o site é interno.

PSM
psm integer

O identificador do Product Service Manager.

siteLabelDisplay
siteLabelDisplay string

O rótulo de exibição do site.

allowSiteAdministration
allowSiteAdministration integer

Indicar se a administração do local é permitida.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

Para ativar a proteção por senha no nível do site.

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

Para ativar a proteção por código no nível do site.

código de acessoUsingAuthApp
passcodeUsingAuthApp integer

Indica se a autenticação por senha usa um aplicativo de autenticação.

sitePassword
sitePassword string

A palavra-passe associada ao site.

ipRestrictionEnable
ipRestrictionEnable integer

Para habilitar restrições de IP para acesso ao site.

disponívelIP
availableIP string

Lista separada por vírgulas dos endereços IP autorizados a aceder ao site.

highqDrive [en]
highqDrive integer

Indica se a integração do HighQ Drive está ativada.

applySiteHomePage
applySiteHomePage integer

Para aplicar uma home page personalizada para o site.

sitePágina inicial
siteHomePage string

URL da home page personalizada do site.

siteHomePageType
siteHomePageType integer

Tipo da página inicial.

próximoLoginSiteHomePage
nextLoginSiteHomePage integer

Para definir o próximo login na página inicial do site.

aplicarDisplayContent
applyDisplayContent integer

Para aplicar as configurações de conteúdo de exibição.

displayContent
displayContent string

Conteúdo para exibir no site.

rssSegurança
rssSecurity integer

Nível de segurança do feed RSS.

encryptedPassword
encryptedPassword integer

Indica se a senha do site está criptografada.

disponívelIPRangeCSV
availableIPRangeCSV string

Lista separada por vírgulas de intervalos de endereços IP permitidos para acessar o site.

siteModuleID
siteModuleID integer

Identificador do módulo do site.

icalSegurança
icalSecurity integer

Nível de segurança do feed iCal.

defaultDisplayContent
defaultDisplayContent string

Conteúdo padrão a ser exibido no site.

defaultEmailAlert
defaultEmailAlert integer

Para ativar alertas de e-mail padrão.

excelReportFooter
excelReportFooter integer

Inclui um rodapé nos relatórios do Excel.

excelReportFooterText
excelReportFooterText string

Texto a apresentar no rodapé dos relatórios do Excel.

anúncioMLJSON
announcementMLJSON string

Anúncios formatados em JSON para o site.

modeloTipo
templateType integer

Tipo de modelo usado para o site.

templateLicence
templateLicence integer

Tipo de licença para o modelo de site.

openChannelAppID
openChannelAppID string

ID do aplicativo para a integração de canal aberto.

itemid
itemid integer

Identificador do item associado ao site.

SiteMetaDataSheetID
sitemetadatasheetid integer

ID da folha de metadados associada ao site.

mysite
mysite boolean

Indica se este é o site pessoal do usuário.

data de acesso último
lastaccesseddate string

Data e hora em que o site foi acessado pela última vez.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

Guia de metadados padrão para o visualizador do site.

documentMetadataViewId
documentMetadataViewId integer

metadados do documento para identificador de visualização.

pastaMetadataViewId
folderMetadataViewId integer

metadados de pasta para identificador de exibição.

docSort
docSort integer

A ordem de classificação dos documentos.

folderSort
folderSort integer

A ordem de classificação das pastas.

defaultFolderRenderView
defaultFolderRenderView integer

Determina o modo de exibição padrão para pastas.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

O local padrão para anexos de tarefas.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

O identificador exclusivo da pasta designada como o local padrão para anexos de tarefas.

favorito
favourite string

status favorito.

enabledocumentredaction
enabledocumentredaction boolean

Especifica se a redação de documentos está habilitada para o site.

grupos de menção
mentiongroups integer

Os grupos mencionados.

EnableFileRelationships
enablefilerelationships boolean

Indica se as relações de arquivo estão habilitadas.

FileRelationshipSitePermissionLevel
filerelationshipsitepermissionlevel integer

O nível de permissão necessário para gerenciar relações de arquivo.

Devoluções

Body
site

Adicionar utilizador

Esta chamada de API é usada para adicionar um novo usuário ao sistema.
Nota:
1. Adicionado suporte para os seguintes novos campos
emaildomain, org, invitationsent, createdby, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. A tag de endereço foi adicionada na API versão 4

1

Resumo Código Ref (antes de V4) Código Ref (V4)

O endereço de e-mail é obrigatório

101 101

Endereço de e-mail inválido

104 104

O nome próprio é obrigatório

102 102

O máximo de caracteres permitidos para o primeiro nome deve estar entre 1 e 100

102 352

O endereço de e-mail da secretária/assistente não é válido

104 353

O status deve estar ativo ou inativo

116 116

O departamento inserido não pode ter mais de 256 caracteres

N/A 354

O atributo ifpartner inserido é inválido

N/A 355

O atributo systemuser inserido é inválido

N/A 356

O atributo usertypeid inserido é inválido

N/A 357

O atributo langcode inserido é inválido

N/A 358

O atributo sourcetype inserido é inválido. Os valores válidos são System, Ative directory ou System default .

N/A 359

Introduza um número de telefone válido   

N/A 360

Introduza um número de telefone válido no formato {countrycode}  ${areacode}${number}.

N/A 361

Introduza um número de telemóvel válido no formato {countrycode}${number}.

N/A 362

Insira um código de país de telefone de escritório válido

N/A 363

O código de país do telefone do escritório pode ter um máximo de 4 dígitos

N/A 364

Insira um código de área de telefone de escritório válido

N/A 365

O código de área do telefone do escritório pode ter um máximo de 5 dígitos

N/A 366

O número de telefone do escritório deve ter no máximo 15 dígitos

N/A 368

Introduza um código de país de telemóvel válido

N/A 369

O código de país do telemóvel pode ter um máximo de 4 dígitos

N/A 372

Introduza um número de telemóvel válido

N/A 373

Número de telemóvel deve ter no máximo 20 dígitos

N/A 374

O domínio não existe

105 105

O email já existe no sistema

111 111

Mencionar organização no caso de domínio auto-registado   

187 187

Mencionar organização em caso de domínio excecional   

115 115

O ID da organização não está no formato adequado   

112 112

Organização não existe

106 106

Domínio existe noutra organização

114 114

O ID de endereço inserido não é válido

N/A 308

Nome do link social não encontrado no sistema.

N/A 375

O nome do link social é obrigatório

N/A 376

O valor do link social é necessário

N/A 377

O máximo de caracteres para o valor do link social deve estar entre 1 e 500

N/A 378

Insira o nome do link personalizado

N/A 379

O valor de link personalizado necessário

N/A 380

O máximo de caracteres para o nome do link personalizado deve estar entre 1 e 500

N/A 381

O máximo de caracteres para o valor do link personalizado deve estar entre 1 e 500

N/A 382

O nome do link da mensagem necessário

N/A 383

Nome do link da mensagem não encontrado no sistema

N/A 384

O valor do link da mensagem necessário   

N/A 385

O máximo de caracteres para o valor do link de mensagem deve estar entre 1 e 500

N/A 386

O link social está desativado

N/A 408

O link da mensagem está desativado

N/A 409

O link personalizado está desativado

N/A 410

Bilhete JIRA : https://dev.highq.com/jira/browse/COL-65685

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Versão da API

indexar
index integer

Índice exclusivo para o usuário.

ID de usuário
userid integer

Identificador exclusivo para o usuário.

Nome próprio
firstname string

Nome próprio do utilizador.

Apelido
lastname string

Apelido do utilizador.

grupo de prática
practicegroup string

Grupo de prática ao qual o usuário pertence.

código de lang
langcode string

Código linguístico do utilizador.

localeID
localeID string

ID de localidade do usuário.

perfil público
publicprofile string

Perfil público do utilizador.

pwpid
pwpid string

ID PWP do usuário.

usertypeid
usertypeid string

ID do tipo de usuário.

systemuser
systemuser string

Sinalizador de usuário do sistema.

e-mail
email string

Endereço de e-mail do usuário.

phone
phone string

Número de telefone do utilizador.

móvel
mobile string

Número de telemóvel do utilizador.

departamento
department string

Departamento do usuário.

organização
org string

Organização à qual o usuário pertence.

endereço1
addressline1 string

Primeira linha do endereço.

endereço2
addressline2 string

Segunda linha do endereço.

endereço3
addressline3 string

Terceira linha do endereço.

city
city string

Cidade do endereço.

state
state string

Estado do endereço.

country
country string

País do endereço.

código postal
postcode string

Código postal do endereço.

endereçoid
addressid string

Identificador exclusivo do endereço.

endereço1
addressline1 string

Primeira linha do endereço.

endereço2
addressline2 string

Segunda linha do endereço.

endereço3
addressline3 string

Terceira linha do endereço.

city
city string

Cidade do endereço.

state
state string

Estado do endereço.

country
country string

País do endereço.

Código postal
postCode string

Código postal do endereço.

conhecido como
knownas string

Nome ou alcunha alternativos para a morada.

experiência
experience array of string
id
id string

Link ID

nome
name string

Nome do link.

valor
value string

Valor do link.

id
id string

Link ID

nome
name string

Nome do link.

valor
value string

Valor do link.

id
id string

Link ID

nome
name string

Nome do link.

valor
value string

Valor do link.

IMG
img string
relatóriospara
reportsto string
MetadataName
metadataname array of string
valor dos metadados
metadatavalue array of string
agrupar
group array of string
ExternalID
externalid string

ID externo do utilizador.

cargo:
jobtitle string

Cargo do usuário.

nome do secretário
secretaryname string

Nome do secretário do usuário.

correio de secretária
secretarymail string

E-mail da secretária do usuário.

Especialidades
specialities string

Especialidades do utilizador.

title
title string

Título do utilizador.

Goesby
goesby string

nome preferencial do usuário.

sufixo
suffix string

Sufixo do nome do usuário.

atomlink
atomlink string

Link Atom associado ao usuário.

biografia
bio string

Biografia do utilizador.

dateOfBirth
dateOfBirth string

Data de nascimento do utilizador.

ligação
link string

Link associado ao usuário.

estado
status string

Status do usuário.

código de estado
statuscode string

Código de status do usuário.

mensagem
message string

Mensagem associada ao utilizador.

Tipo de fonte
sourcetype string

Tipo de origem do usuário.

Orgid
orgid string

ID da organização.

ifpartner
ifpartner string

Bandeira de parceiro.

emaildomain
emaildomain string

Domínio de e-mail do usuário.

conviteenviado
invitationsent string

Bandeira de convite enviado.

criado por
createdby string

Usuário que criou o registro.

data de criação
createddate string

Data em que o registo foi criado.

modificadopor
modifiedby string

Usuário que modificou o registro.

data modificada
modifieddate string

Data em que o registo foi modificado.

LastLoginDate
lastlogindate string

Data do último login.

logins inválidos
invalidlogins string

Contagem de tentativas de login inválidas.

publicwebsiteprofileid
publicwebsiteprofileid string

ID do perfil do site público.

ResetPasswordDate
resetpassworddate string

Data em que a palavra-passe foi reposta.

Avatar
avatar string

URL da imagem do avatar.

contagem de seguidores
followingcount integer

Contagem de usuários sendo seguidos.

contagem de seguidores
followercount integer

Contagem de seguidores.

a seguir
following boolean

Seguindo a bandeira.

função
role string

Papel do utilizador.

isbasicuser
isbasicuser string

Sinalizador de usuário básico.

encryptedUserId
encryptedUserId string

ID de utilizador encriptado.

auto-registado
selfregistered integer

Bandeira auto-registrada.

registadoWith2FA
registeredWith2FA string

Sinalizador de registro de autenticação de dois fatores.

isInterno
isInternal integer

Sinalizador de usuário interno.

orgName
orgName string

Nome da organização.

Devoluções

Arquivar Utilizador

Esta chamada de API é usada para arquivar um usuário dentro do sistema.

Códigos de erro

Resumo Código Ref (antes de V4) Código Ref (V4)

Os seguintes usuários não existem dentro do sistema:

110 110

É necessário um ID de utilizador

109 109

 ID de usuário não está no formato adequado

113 113

O comprimento do ID do usuário não pode exceder 50 caracteres

N/A 304


Bilhete JIRA : https://dev.highq.com/jira/browse/COL-67441

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Versão da API

ID do Utilizador
userid True string

ID de utilizador

Atualizar grupo de sites

Esse método de API atualiza o nome de um grupo existente em um site.
Essa API foi estendida para atualizar o nome de um grupo de usuários básicos existente em um site.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

versão

O ID do site
siteid True string

O ID do site.

Versão da API
groupid True string
The ID of the site group.
nome
name string
id
id integer
copypermissionsfrom
copypermissionsfrom string
mensagem
message string
typeID
typeID integer
tipo
type string
Número de utilizadores
numberofusers string
criado
created string
modified
modified string
systemGroupID
systemGroupID integer
descrição
description string
basicusergroup
basicusergroup integer

Devoluções

Body
sitegroup

Atualizar site

Use este ponto de extremidade da API para atualizar os detalhes de um site existente. A API suporta os mesmos campos usados em Criar API de site.

Este método suporta vários números de matéria para adicionar ao site usando a API versão 10 em diante. A tag "matternos" indica vários números de matéria com somente leitura ou não.

Versão 18 em diante: é necessária uma categoria (finalidade do site). Se a finalidade do site estiver oculta, uma mensagem será exibida; caso contrário, as finalidades ocultas do site não serão adicionadas ao site.

Agora, o proprietário do site também pode receber outros usuários, mas eles devem ser participantes do site e ter uma função superior à de administrador do site.

Versão 18 em diante: o proprietário do site pode adicionar outros usuários ao site.

A partir da API versão 19, um novo módulo chamado customPages é introduzido, que é fortemente acoplado ao módulo home. Se o valor do módulo inicial for True, customPages terá que ser true e vice-versa.

Observe que todas as propriedades/elementos em obter resposta do site não são atualizáveis/inseríveis. Veja a tabela abaixo para saber quais são somente leitura, atualizáveis ou inseríveis.

Parâmetros

Name Chave Necessário Tipo Description
A versão da API que está sendo solicitada
version True string

Versão da API

O identificador exclusivo do site
siteid True string

A ID do site

id
id integer

O identificador do site.

nome do site
sitename string

O nome do site.

função
role string

O papel do site.

Descrição do site
sitedescription string

A descrição do site.

módulos habilitados
enabledmodules string

Uma lista de módulos habilitados para o site.

sitefolderID
sitefolderID string

O identificador da pasta do site.

sitefolderpermission
sitefolderpermission string

O nível de permissão para a pasta do site.

activar
enable string

Habilite o status para HomeDBO.

activar
enable string

Habilite o status para ActivityDBO.

microblog
microblog string

Conteúdo de microblog associado ao ActivityDBO.

Docid
docid string

ID do documento.

blogTítulo
blogTitle string

Título da postagem do blog.

blogConteúdo
blogContent string

Conteúdo da postagem do blog.

showComment
showComment integer

mostrar o comentário.

tagLista
tagList array of string

Lista de tags associadas ao blog.

estado
status integer

status da postagem do blog.

ID do site
siteID integer

Identificador do site associado.

autor
author string

Autor do blog.

categoryList
categoryList array of string

Categorias atribuídas à postagem do blog.

notificationTypeID
notificationTypeID integer

Identificador do tipo de notificação.

mensagem
message string

Conteúdo da mensagem relacionado ao blog.

Código da mensagem
messageCode integer

Código associado à mensagem.

ID externo
externalID string

Identificador externo vinculado ao blog.

publicarData
publishDate string

Data de publicação do blog.

tipo de processo
processtype string

Tipo de processo associado ao blog.

activar
enable string

Habilite o status para BlogDBO.

Wikiid
wikiid integer

Identificador exclusivo para o wiki.

CurrentVersionID
currentversionid integer

Identificador da versão atual do wiki

parentwikiid
parentwikiid integer

Identificador do wiki pai.

título wiki
wikititle string

Título da wiki.

conteúdo wiki
wikicontent string

Conteúdo da wiki.

showcomment
showcomment integer

Indicando se os comentários estão habilitados.

data de criação
createddate string

Data de criação da wiki.

data modificada
modifieddate string

Data da última modificação da wiki.

Lista de tags
taglist string

Lista separada por vírgulas de tags associadas ao wiki.

Wikicaminho
wikipath string

Caminho para acessar o wiki.

WikiDraftID
wikidraftid integer

Identificador da versão preliminar do wiki.

Tipo de rascunho
drafttype string

Tipo de rascunho associado ao wiki.

estado
status integer

Status atual do wiki.

WikiVersionID
wikiversionid integer

Identificador de versão do wiki.

indexar
index string

Índice ou identificador da tarefa.

ParentTaskID
parenttaskid integer

Identificador da tarefa pai.

TaskID
taskid integer

Identificador exclusivo da tarefa.

title
title string

Título da tarefa.

descrição
description string

Descrição detalhada da tarefa.

Data de vencimento
duedate string

Data de conclusão da tarefa.

data de início
startdate string

Data de início em que a tarefa foi iniciada.

MatterMapTaskID
mattermaptaskid string

Identificador vinculado à tarefa de mapa de matéria.

tipo
type string

Tipo ou categoria da tarefa.

dependente
dependenton string

Tarefas das quais esta tarefa depende.

diasdedependentes
daysfromdependent string

Número de dias da tarefa dependente.

ignorarfim de semana
ignoreweekend integer

Indica se os fins de semana são ignorados na programação.

duration
duration integer

Duração para concluir a tarefa.

recurso
resource string

Recursos atribuídos à tarefa.

eventoTítulo
eventTitle string

Título do evento.

eventoConteúdo
eventContent string

Conteúdo do evento.

showComment
showComment integer

Indicando se os comentários estão habilitados para o evento.

tagLista
tagList array of string

Lista de tags associadas ao evento.

estado
status integer

Estado atual do evento.

ID do site
siteID integer

Identificador do site.

contacto
contact string

Informações de contacto para o evento.

categoryList
categoryList array of string

Categorias sob as quais o evento está listado.

notificationTypeID
notificationTypeID integer

O tipo de notificação relacionado ao evento.

mensagem
message string

A mensagem do evento.

Código da mensagem
messageCode integer

O código da mensagem do evento.

ID externo
externalID string

O identificador externo.

startDate
startDate string

A data de início do evento.

data de término
endDate string

A data final do evento.

startTime
startTime string

A hora de início do evento.

endTime
endTime string

A hora de término do evento.

localização
location string

O local do evento.

autor
author string

O autor do evento.

tipo de processo
processtype string

O tempo de processo do evento.

activar
enable string

Habilitar o evento.

id
id integer

Identificador exclusivo do iSheet.

title
title string

Título do iSheet.

descrição
description string

Descrição do isheet.

estado
status string

Estado do isheet.

tipo de acesso
accesstype string

Tipo de acesso do isheet.

tipo
type string

Tipo de isheet.

Ver link
viewlink string

Link para visualizar o iSheet.

allowsections
allowsections string

Se as seções são permitidas.

PermitirPesquisa
allowlookup string

Se os campos de pesquisa estão habilitados.

displayisheet
displayisheet string

Opções de exibição para o iSheet.

SearchAsDefaultView
searchasdefaultview string

Indica se a pesquisa é o modo de exibição padrão.

enableversion
enableversion string

Sinalizador de controle de versão habilitado.

EnableSheetAlerter
enablesheetalerter string

Sinalizador para ativar alertas de folha.

alertercondition
alertercondition string

Condições para acionar alertas.

OverrideItemModifiedDate
overrideitemmodifieddate string

Substituir sinalizador de data modificado.

EnableBulkInsertUpdate
enablebulkinsertupdate string

Habilite a inserção/atualização em massa.

descrições de campo
fielddescriptions string

Descrições de campos para o iSheet.

EnableRowLocking
enablerowlocking string

Habilite o bloqueio em nível de linha.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Truncar sinalizador de texto de várias linhas.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Limite de caracteres para truncamento de várias linhas.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Permitir a reutilização dos valores da lista de opções.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Permitir a reutilização dos valores da lista de pontuações.

allowIsheetComentários
allowIsheetComments string

Permitir comentários no iSheet.

shareRecordsLimit
shareRecordsLimit integer

Limite de registos permitidos a partilhar.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Limite de compartilhamento de registros habilitado.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Habilite o compartilhamento de formulários para adicionar registros.

contagem de recordes
recordcount string

Contagem recorde atual.

sheettypeid
sheettypeid integer

ID do tipo do iSheet

activar
enable string

Habilite a funcionalidade de controle de qualidade.

ID de usuário
userid integer

ID de Utilizador.

e-mail
email string

endereço de e-mail.

httpavatar
httpavatar string

URL HTTP do avatar.

Avatar
avatar string

Imagem do avatar.

link de usuário
userlink string

Link para o perfil do usuário.

Ligação http
httplink string

Link HTTP para o perfil do usuário.

phone
phone string

Número de telefone.

móvel
mobile string

Número de telemóvel.

departamento
department string

Departamento do utilizador.

activar
enable string

Habilite a integração do Contract Express.

nota de administrador
adminnote string

Notas administrativas relacionadas com o site.

data de início
startdate string

A data de início da operação do site.

Data de fim
enddate string

A data final do funcionamento do site.

data de criação
createddate string

A data em que o site foi criado.

data de arquivo
archiveddate string

A data em que o site foi arquivado.

clienteno
clientno string

O número de cliente associado ao site.

não importa
matterno string

O número da matéria associada ao site.

página de aterragem
landingpage string

O URL da página de destino do site.

ligação
link string

Um link relacionado ao site.

estado
status string

O status atual do site.

StatusID
statusid integer

O identificador do status do site.

size
size string

O tamanho do site.

notas de faturação
billingnotes string

Notas relacionadas com a faturação do site.

faturamentopróximodata da fatura
billingnextinvoicedate string

A data da próxima fatura do site.

billinglastinvoicedate
billinglastinvoicedate string

A data da última fatura do site.

FilePageCount
filepagecount string

A contagem total de páginas de arquivos no site.

MaxPageCount
maxpagecount string

A contagem máxima de páginas permitida para arquivos no site.

sítiohttplink
sitehttplink string

O link HTTP para o site.

isSyncable
isSyncable integer

Indica se o site é sincronizável.

EnforceUserGroups
enforceusergroups string

Os grupos de usuários impostos para o site.

csvSiteCategory
csvSiteCategory string

A categoria do site em formato CSV.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

O nome do site no idioma padrão.

visível
visible integer

Indica se o site está visível.

siteLogoName
siteLogoName string

O nome do arquivo de logotipo do site.

siteLogoFileSize
siteLogoFileSize integer

O tamanho do arquivo do logotipo do site.

siteLogoHeight
siteLogoHeight integer

A altura do logotipo do site.

siteLogoWidth
siteLogoWidth integer

A largura do logotipo do site.

Estado do site
siteStatus integer

O código de status do site.

applyTermos do Site
applySiteTerms integer

Indica se os termos do site são aplicados.

siteTerm
siteTerm string

Os termos aplicam-se ao site.

termType
termType integer

O tipo de termos aplicados ao site.

nextLoginSiteTermos
nextLoginSiteTerms integer

Indica se os termos do site são necessários no próximo login.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

Indica se os termos padrão do site estão habilitados.

advancedQAPermission
advancedQAPermission integer

O nível de permissão de QA avançado para o site.

isInterno
isInternal integer

Indica se o site é interno.

PSM
psm integer

O identificador do Product Service Manager.

siteLabelDisplay
siteLabelDisplay string

O rótulo de exibição do site.

allowSiteAdministration
allowSiteAdministration integer

Indicar se a administração do local é permitida.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

Para ativar a proteção por senha no nível do site.

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

Para ativar a proteção por código no nível do site.

código de acessoUsingAuthApp
passcodeUsingAuthApp integer

Indica se a autenticação por senha usa um aplicativo de autenticação.

sitePassword
sitePassword string

A palavra-passe associada ao site.

ipRestrictionEnable
ipRestrictionEnable integer

Para habilitar restrições de IP para acesso ao site.

disponívelIP
availableIP string

Lista separada por vírgulas dos endereços IP autorizados a aceder ao site.

highqDrive [en]
highqDrive integer

Indica se a integração do HighQ Drive está ativada.

applySiteHomePage
applySiteHomePage integer

Para aplicar uma home page personalizada para o site.

sitePágina inicial
siteHomePage string

URL da home page personalizada do site.

siteHomePageType
siteHomePageType integer

Tipo da página inicial.

próximoLoginSiteHomePage
nextLoginSiteHomePage integer

Para definir o próximo login na página inicial do site.

aplicarDisplayContent
applyDisplayContent integer

Para aplicar as configurações de conteúdo de exibição.

displayContent
displayContent string

Conteúdo para exibir no site.

rssSegurança
rssSecurity integer

Nível de segurança do feed RSS.

encryptedPassword
encryptedPassword integer

Indica se a senha do site está criptografada.

disponívelIPRangeCSV
availableIPRangeCSV string

Lista separada por vírgulas de intervalos de endereços IP permitidos para acessar o site.

siteModuleID
siteModuleID integer

Identificador do módulo do site.

icalSegurança
icalSecurity integer

Nível de segurança do feed iCal.

defaultDisplayContent
defaultDisplayContent string

Conteúdo padrão a ser exibido no site.

defaultEmailAlert
defaultEmailAlert integer

Para ativar alertas de e-mail padrão.

excelReportFooter
excelReportFooter integer

Inclui um rodapé nos relatórios do Excel.

excelReportFooterText
excelReportFooterText string

Texto a apresentar no rodapé dos relatórios do Excel.

anúncioMLJSON
announcementMLJSON string

Anúncios formatados em JSON para o site.

modeloTipo
templateType integer

Tipo de modelo usado para o site.

templateLicence
templateLicence integer

Tipo de licença para o modelo de site.

openChannelAppID
openChannelAppID string

ID do aplicativo para a integração de canal aberto.

itemid
itemid integer

Identificador do item associado ao site.

SiteMetaDataSheetID
sitemetadatasheetid integer

ID da folha de metadados associada ao site.

mysite
mysite boolean

Indica se este é o site pessoal do usuário.

data de acesso último
lastaccesseddate string

Data e hora em que o site foi acessado pela última vez.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

Guia de metadados padrão para o visualizador do site.

documentMetadataViewId
documentMetadataViewId integer

metadados do documento para identificador de visualização.

pastaMetadataViewId
folderMetadataViewId integer

metadados de pasta para identificador de exibição.

docSort
docSort integer

A ordem de classificação dos documentos.

folderSort
folderSort integer

A ordem de classificação das pastas.

defaultFolderRenderView
defaultFolderRenderView integer

Determina o modo de exibição padrão para pastas.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

O local padrão para anexos de tarefas.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

O identificador exclusivo da pasta designada como o local padrão para anexos de tarefas.

favorito
favourite string

status favorito.

enabledocumentredaction
enabledocumentredaction boolean

Especifica se a redação de documentos está habilitada para o site.

grupos de menção
mentiongroups integer

Os grupos mencionados.

EnableFileRelationships
enablefilerelationships boolean

Indica se as relações de arquivo estão habilitadas.

FileRelationshipSitePermissionLevel
filerelationshipsitepermissionlevel integer

O nível de permissão necessário para gerenciar relações de arquivo.

Carregar um ficheiro

Esta chamada de API carrega um arquivo para uma pasta especificada na plataforma HighQ Collaborate. Ele suporta uploads em partes quando o cabeçalho Content-Range é fornecido.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Especifica a versão da API que está sendo usada.

Arquivo para carregar
file True file

Especifica o arquivo a ser carregado.

ID da pasta principal
parentfolderid True string

Especifica a ID exclusiva da pasta pai onde o arquivo será carregado.

Substituir sinalizador duplicado
overrideduplicate boolean

Indica se os carregamentos de arquivos duplicados devem ser substituídos.

Nome do documento
filename True string

Especifica o nome do documento.

Nota sobre a versão
versionnote string

Fornece uma nota descrevendo a versão do arquivo.

Chave de operação progressiva
progressiveoperkey string

Especifica a chave usada para operações progressivas durante o carregamento do arquivo.

Nome do banco de dados DMS
dmsdatabasename string

Especifica o nome do banco de dados do Sistema de Gerenciamento de Documentos.

Data de edição do DMS
dmseditdate string

Especifica a data de edição registrada no Sistema de Gerenciamento de Documentos.

ID da Pasta Principal DMS
dmsparentfolderid string

Especifica a ID exclusiva da pasta pai no Sistema de Gerenciamento de Documentos.

ID do documento DMS
dmsdocid string

Especifica a ID exclusiva do documento no Sistema de Gerenciamento de Documentos.

Versão do documento DMS
dmsversion string

Especifica a versão do documento registrado no Sistema de Gerenciamento de Documentos.

Detalhes da notificação
notification string

Fornece detalhes sobre quaisquer notificações a serem enviadas após o upload do arquivo.

ID do lote
batchid string

Especifica a ID exclusiva da operação em lote.

ID da pasta raiz
rootfolderid string

Especifica a ID exclusiva da pasta raiz.

Criar pasta

Esta API cria uma nova pasta dentro do site especificado. Ele permite que você forneça detalhes da pasta e garante que a pasta seja criada sob a pasta pai fornecida.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Especifica a versão da API.

Identificador de lote
batchid string

Um identificador exclusivo para a operação em lote.

ID da pasta raiz
rootfolderid string

O identificador exclusivo da pasta raiz.

ID da pasta principal
parentfolderid True string

O identificador exclusivo da pasta pai onde a nova pasta será criada.

Permitir pasta duplicada
allowduplicatefolder boolean

Indica se pastas duplicadas são permitidas na pasta pai especificada.

nome
name True string

O nome da pasta.

descrição
description string

Uma descrição da pasta.

accessHerdado
accessInherited integer

Indica se o acesso à pasta é herdado.

ID do lote
batchID string

O identificador de lote para a operação.

dmsfolderid
dmsfolderid string

O identificador de pasta DMS.

dmsParentFolderID
dmsParentFolderID string

O identificador da pasta pai DMS.

dmscreateddate
dmscreateddate date-time

A data em que a pasta DMS foi criada.

dmsmodifiedPor
dmsmodifiedBy string

O usuário que modificou pela última vez a pasta DMS.

dmsdatabasename
dmsdatabasename string

O nome do banco de dados DMS.

DMSlink
dmslink boolean

Indica se um link DMS está disponível.

DMSLinkby
dmslinkby string

O usuário que vinculou a pasta DMS.

emailmetadata
emailmetadata string

Metadados de e-mail associados à pasta.

Devoluções

Mover documentos

Essa API move vários arquivos de uma pasta para outra dentro do mesmo site.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Especifica a versão da API.

ID da pasta de destino
targetfolder True string

O identificador exclusivo da pasta de destino para onde os arquivos serão movidos.

fileidCSV
fileidCSV string

A lista separada por vírgulas de IDs de arquivo a serem movidos.

Obter informações da pasta

O método fornece detalhes da pasta de determinada ID de pasta.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Versão da API

ID da pasta
folderid True string

ID da pasta

Informações de status
statusinfo boolean

O parâmetro statusinfo permite que você acesse informações adicionais sobre a pasta. As informações disponíveis incluem Estado Partilhado, Estado Favorito para utilizador com sessão iniciada

Devoluções

Para criar o item do iSheet

Esta chamada de API é usada para inserir o item do iSheet. Vários iSheets podem ser suportados.

Para obter o status de um item do iSheet com base em uma chave progressiva, chame API POST /api/3/progressivekeystatus/{progressive_key}

por exemplo, POST /api/{version}/progressivekeystatus/{progressive_key}

NomeTipoDescription
progressive_keyCordão Chave para verificar o status da sua ação.

Resposta

<ProgressiveKeyResponse>
 \t<itens>
  \t\t<item>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<mensagem>Registro adicionado com êxito</mensagem>
  \t\t</item>
  \t\t<item>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t<mensagem>Registro adicionado com êxito</mensagem>
  \t\t</item>
 \t</itens>
</progressivekeyresponse>

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Versão da api

Identificador do iSheet
isheetid True integer

ID do iSheet

Identificador do Modo de Exibição de Planilha
sheetviewid integer

ID da vista do iSheet (opcional)

id
id integer

Identificador Isheet.

title
title string

Título da folha.

descrição
description string

Descrição da folha.

estado
status string

Estado da folha.

tipo de acesso
accesstype string

Tipo de acesso da folha.

tipo
type string

Tipo de folha.

Ver link
viewlink string

Link de URL para visualizar a planilha.

allowsections
allowsections string

Indica se as seções são permitidas.

PermitirPesquisa
allowlookup string

Indica se a pesquisa é permitida.

displayisheet
displayisheet string

Exiba o isheet.

SearchAsDefaultView
searchasdefaultview string

Define a pesquisa como modo de exibição padrão.

enableversion
enableversion string

Ativar versão.

EnableSheetAlerter
enablesheetalerter string

Ativa o alerta de folha.

alertercondition
alertercondition string

Condição para disparar alertas.

OverrideItemModifiedDate
overrideitemmodifieddate string

Sobre a data de modificação do item.

EnableBulkInsertUpdate
enablebulkinsertupdate string

Permitir atualização de inserção em massa.

descrições de campo
fielddescriptions string

descrição dos campos.

EnableRowLocking
enablerowlocking string

Permite o bloqueio de linha.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Habilita o truncamento de limite de caracteres para texto com várias linhas.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Define limite de caracteres para truncamento.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Permite a reutilização de valores da lista de opções.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Permite a reutilização dos valores da lista de pontuação.

allowIsheetComentários
allowIsheetComments string

Permite comentários na folha.

shareRecordsLimit
shareRecordsLimit integer

Limite de registros compartilhados.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Habilite o limite de registro de compartilhamento.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Permite o compartilhamento do formulário de adição de registro.

allowViewBaseRendering
allowViewBaseRendering string

Permite renderização base de visualizações.

coluna
column object
contagem de recordes
recordcount string

Número total de registos.

viewId
viewId integer

Identificador exclusivo para a exibição.

siteId
siteId integer

Identificador do site associado.

Nome do site
siteName string

Nome do site.

sheetName
sheetName string

Nome da folha.

viewName
viewName string

Nome do modo de exibição.

sheetId
sheetId integer

Identificador da folha.

sequência
sequence string

Número de sequência da coluna de cabeçalho.

columnValue
columnValue string

Valor da coluna de cabeçalho.

columnTypeId
columnTypeId string

Identificador do tipo de coluna.

columnId
columnId string

Identificador exclusivo da coluna.

columnTypeAlias
columnTypeAlias string

Nome do alias para o tipo de coluna.

ItemSequence
itemsequence string

Número sequencial do item.

itemid
itemid string

Identificador exclusivo do item.

ExternalID
externalid string

Identificador externo associado ao item.

columnid
columnid integer

Identificador exclusivo da coluna

nome
name string

Nome da coluna

tipo
type integer

Tipo de dados da coluna.

SystemGeneratedType
systemgeneratedtype string

Informações de tipo geradas pelo sistema.

section
section integer

Número da secção onde se encontra a coluna.

descrição
description string

Descrição detalhada da coluna.

addtodefaultview
addtodefaultview string

Indica se a coluna é adicionada ao modo de exibição padrão.

columnconditionstate
columnconditionstate string

Estado do estado da coluna.

rowid
rowid integer

Identificador da linha.

columnid
columnid integer

Identificador da coluna.

ID do operador
operatorid integer

Identificador do operador.

Oprand
oprand string

Valor do operando para o filtro.

tipo lógico
logicaltype string

Tipo lógico do filtro.

SheetFilterValueTypeId
sheetfiltervaluetypeid string

ID do tipo de valor do filtro de folha.

tipo de exibição
displaytype string

Tipo de exibição do filtro.

sourceColumnId
sourceColumnId integer

ID da coluna de origem do filtro.

scoreConditionTypeid
scoreConditionTypeid integer

ID para o tipo de condição de pontuação.

defaultvalue
defaultvalue string

Valor padrão para a coluna.

largura da coluna
columnwidth string

Largura da coluna.

nome da folha
sheetname string

Nome da folha associada.

nome do site
sitename string

Nome do site.

obrigatório
mandatory string

Indica se a coluna é obrigatória.

PermitirPesquisa
allowsearch string

Especifica se a pesquisa é permitida.

Maxchars
maxchars integer

Número máximo de caracteres.

allowfieldfromanotherisheet
allowfieldfromanotherisheet string

Permite campo de outra folha.

AllowRichHtmlText
allowrichhtmltext string

Especifica se rich HTML text é permitido.

número de linhas
numberoflines integer

Número de linhas na coluna.

displaymethod
displaymethod string

Método usado para exibir a coluna.

includeotheroption
includeotheroption string

Inclui uma opção 'Outros'.

singleormultileselectioninsearch
singleormultileselectioninsearch string

Especifica o tipo de seleção na pesquisa.

id
id string

Identificador único para a escolha."

etiqueta
label string

Rótulo para a escolha.

classificação
score string

Pontuação associada à escolha.

color
color string

Código de cores para a escolha.

imageid
imageid integer

ID da imagem associada.

includeinalertpreferences
includeinalertpreferences string

Inclui nas preferências de alerta.

min
min string

Valor mínimo para a coluna.

max
max string

Valor máximo para a coluna.

casas decimais
decimalplaces integer

Número de casas decimais.

showthousandseparadores
showthousandseparators string

Exibe milhares de separadores.

showaspercentagem
showaspercentage string

Exibe o valor como porcentagem.

formattype
formattype string

Especifica o tipo de formato da coluna.

formato de data
dateformat string

Define o formato de data para a coluna.

defaultdateandtime
defaultdateandtime string

Define o valor de data e hora padrão para a coluna.

Sheetlookup
sheetlookup string

Indica se a coluna é uma pesquisa para outra folha.

exibição de campo
fielddisplay string

Determina como o campo é exibido.

PermitirMúltiplos Utilizadores
allowmultipleusers string

Especifica se vários usuários podem acessar o campo.

tipo de método
methodtype string

Define o tipo de método para a coluna.

Sheetids
sheetids string

Lista as IDs das planilhas associadas à coluna.

AllowUserStoreNameLinks
allowuserstorenamelinks string

Indica se os usuários podem renomear links na coluna.

Sheetid
sheetid integer

Especifica a ID da planilha.

ColumnIDs
columnids string

Lista os IDs das colunas.

viewid
viewid integer

Especifica a ID do modo de exibição.

PermitirMúltiplos Valores
allowmultiplevalues string

Indica se vários valores são permitidos na coluna.

restringirexcluir
restrictdelete string

Especifica se a exclusão é restrita para a coluna.

displaycolumnnameprefix
displaycolumnnameprefix string

Define o prefixo para a exibição do nome da coluna.

nome do link
linkname string

Define o nome do link associado à coluna.

donotcountweekendsonlycountmontofri
donotcountweekendsonlycountmontofri string

Especifica se os fins de semana são excluídos na contagem.

CurrentSheetColumnID
currentsheetcolumnid integer

ID da coluna da folha atual.

TargetSheetColumnID
targetsheetcolumnid integer

ID da coluna da folha de destino.

fórmula
formula string

Especifica a fórmula aplicada à coluna.

valor inicial
startvalue integer

Define o valor inicial da coluna.

prefix
prefix string

Define o prefixo para os valores de coluna.

Postfix
postfix string

Define o postfix para os valores da coluna.

comprimento mínimo
minlength integer

Especifica o comprimento mínimo dos valores da coluna.

lookupglossarysheetid
lookupglossarysheetid integer

Especifica a ID da folha de glossário de pesquisa.

LookUpGlossarySheetViewID
lookupglossarysheetviewid integer

Especifica a ID de exibição da folha de glossário de pesquisa.

Largura
width integer

Define a largura da coluna.

outroscorevalue
otherscorevalue string

Define o outro valor de pontuação para a coluna.

ImportDatafromExternalSource
importdatafromexternalsource string

Indica se os dados são importados de uma fonte externa.

Mecanismo de análise
analysisengine string

Especifica o mecanismo de análise usado para a coluna.

AttachmentCustomFolderId
attachmentcustomfolderid integer

Especifica a ID da pasta personalizada para anexos.

isAttachmentFolderCurrentSite
isattachmentfoldercurrentsite integer

Indica se a pasta de anexos está no site atual.

singleLineEmailValidation
singleLineEmailValidation string

Especifica se a validação de email de linha única é aplicada.

só de leitura
readonly string

Indica se a coluna é somente leitura.

virtualColumn
virtualColumn integer

Especifica se a coluna é virtual.

allowInlineEditing
allowInlineEditing string

Indica se a edição embutida é permitida para a coluna.

sequência
sequence string

Número sequencial da coluna.

AttributeColumnID
attributecolumnid string

Identificador de coluna de atributo.

valor
value string

Valor dos dados brutos.

date
date string

data dos dados brutos.

time
time string

Tempo de dados brutos.

linkdisplayname
linkdisplayname string

Exibir nome do link.

linkdisplayurl
linkdisplayurl string

Exibir link de URL.

id
id string

ID de pesquisa

e-mail
email string

Endereço de e-mail.

userlookuptype
userlookuptype string

Tipo de pesquisa de usuário.

FolderID
folderid string

ID da pasta.

Docid
docid string

ID do documento.

a partir da data
fromdate string

A partir da data.

até à data
todate string

Até à data.

ficheiro
file string

O conteúdo do arquivo.

nome
name string

O nome do anexo.

order
order string

A ordem da penhora.

id
id integer

Identificador exclusivo do anexo.

extensão
extension string

Extensão de arquivo.

ParentFolderID
parentfolderid integer

ID da pasta pai.

filehttplink
filehttplink string

Link HTTP para acessar o arquivo.

caminho da pasta
folderpath string

Caminho para a pasta que contém o arquivo.

pastahttplink
folderhttplink string

Link HTTP para a pasta.

tamanho do ficheiro
filesize integer

Tamanho do ficheiro em bytes.

redactionStatus
redactionStatus boolean

Indica se o arquivo está redigido.

displayname
displayname string

Nome para exibição do anexo.

SiteID
siteid integer

ID do site associado ao anexo.

RecordID
recordid string

ID do registo.

nome do link
linkname string

Nome do link.

Apilink
apilink string

Link da API.

Ligação http
httplink string

Link HTTP.

colViewPosition
colViewPosition integer

Posição da coluna na vista.

tipo de coluna
columntype string

Tipo de coluna.

createdDate (Data de criação)
createdDate date-time

Data e hora em que a coluna foi criada.

modifiedDate
modifiedDate date-time

Data e hora em que a coluna foi modificada pela última vez.

injectReferenceColumn
injectReferenceColumn integer

Referência a uma coluna injetada

parentColumnID
parentColumnID integer

Identificador da coluna pai.

reusecolumnidfromisheet
reusecolumnidfromisheet integer

ID da coluna reutilizada a partir de uma folha de entrada.

ChoiceListID
choicelistid integer

Identificador da lista de opções associada à coluna.

alerteroption
alerteroption string

Configuração da opção de alerta para o item.

sheettypeid
sheettypeid integer

Identificador do tipo de folha.

habilitarSmartForm
enableSmartForm string

Ativa recursos de formulário inteligente.

allowDeletedItemsView
allowDeletedItemsView string

Permite a visualização de itens excluídos.

allowAllColumnsInCustomView
allowAllColumnsInCustomView string

Permite todas as colunas em modos de exibição personalizados.

Devoluções

Recuperar colunas do iSheet

Esta chamada de API recupera as colunas associadas ao iSheet especificado. Esta funcionalidade é suportada na API versão 3 e superior.

Parâmetros

Name Chave Necessário Tipo Description
ID do iSheet
isheetid True integer

Especifica o ID exclusivo do iSheet para o qual as colunas são necessárias.

Versão da API
version True string

Especifica a versão da API que está sendo usada.

ID do iSheet View
sheetviewid string

Especifica a ID do modo de exibição do iSheet. Se omitidas, todas as colunas serão retornadas.

Incluir colunas excluídas do iSheet
onlyForDeletedIsheet boolean

Indica se as colunas de um iSheet excluído devem ser incluídas. O valor predefinido é false.

Devoluções

Body
columns

Recuperar informações do arquivo

Esta chamada de API recupera informações detalhadas para um arquivo especificado da plataforma HighQ Collaborate.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Especifica a versão da API que está sendo usada.

ID do ficheiro
fileid True string

Especifica a ID exclusiva do arquivo.

Sinalizador de informações DMS mais recente
lastdmsinfo boolean

Indica se as informações mais recentes do Sistema de Gerenciamento de Documentos devem ser recuperadas.

Tipo de pasta
foldertype string

Especifica o tipo de pasta, se aplicável.

Incluir informações de status do arquivo
statusinfo boolean

Indica se as informações adicionais de status do arquivo devem ser incluídas, como status compartilhado, status favorito, contagem de tarefas e status curtido. O valor predefinido é false.

Incluir metadados de e-mail
emailmetadata boolean

Indica se os metadados de email devem ser incluídos, como remetente, destinatários e carimbos de data/hora. O valor predefinido é false.

Devoluções

Recuperar lista de usuários

Recuperar uma lista de usuários Esta API recupera uma lista de usuários do sistema. ## Principais Características - Buscar detalhes do usuário com várias opções de filtragem - Suporta paginação com limit e offset - Novos parâmetros de consulta e campos introduzidos em versões recentes - Resposta estruturada com funções e atributos de usuário ## Novos parâmetros de consulta (Version-Specific) - Introduzido na V12: - systemAdminSearch: Quando definido como 1, só retorna usuários com a função de administrador do sistema. - Introduzido na V18: - userid: Aceita valores separados por vírgulas (CSV). ## Response Body Updates - Novos campos adicionados: - emaildomain, org, invitationsent, createdby,createddatemodifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcodepublicprofiledateOfBirth## Address Format Change (from V11) - A location tag foi renomeada para address consistência . - Exemplo de resposta: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## Funções de usuário (introduzido na API v11+) - Exemplo de resposta: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## Limites & Compensações - Comportamento de limite: - Padrão: 100 se nenhum valor for fornecido. - Use -1 para retornar todos os registros. - Se o valor for menor que , o padrão será -1.100 - Comportamento de deslocamento: - Padrão: 0 se nenhum valor for fornecido. - Se o deslocamento exceder o total de registros, o padrão voltará para 0. ## Novas funções introduzidas - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Códigos de erro | Resumo | Código Ref (Antes V4) | Código Ref (V4) | |---------|----------------------|--------------| | Entrada inválida para o status do usuário (ATIVO, ARQUIVADO, INATIVO) | Artigo 147.º | Artigo 147.º | | O ID da organização é inválido | N/A | 260 | | Valor inválido neverinvited (true/false) | N/A | 387 | | Valor inválido neverlogin (true/false) | N/A | 388 | | Valor inválido groupids | N/A | 214 | | Valor inválido notingroup (true/false) | N/A | 389 | | Inválido ordertype (suportado: nome, organização, estado, etc.) | N/A | 289 | | Inválido orderby (suportado: asc, desc) | N/A | 290 | | Valor inválido offset | 138 | 138 | | Valor inválido limit | 137 | 137 | ## Notas - A partir da V13, esta API está aberta para todos os utilizadores (anteriormente limitada a administradores de sistema). - A partir da V18, o userregistered2FA campo indica se um utilizador se registou no 2FA. --- Esta descrição segue a formatação do esquema Swagger 2.0 e deve ser colocada no campo de descrição no esquema do Conector Personalizado.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Versão da API.

Estado do Utilizador
status string

Filtre os usuários por status: Ativo, Arquivado, Inativo ou Bloqueado.

Deslocamento de paginação
offset string

Posição inicial para paginação.

Limite de Resultados
limit string

Número de itens a devolver por pedido.

ID da Organização
orgid string

Filtre os usuários por ID da organização.

Nunca Utilizadores Convidados
neverinvited string

Recupere usuários que nunca foram convidados.

Nunca utilizadores com sessão iniciada
neverlogin string

Recupere usuários que nunca fizeram login.

ID de utilizador
userid string

Filtre os usuários por seus IDs de usuário exclusivos.

ID do grupo
groupid string

Filtre os usuários por ID de grupo.

Usuários que não estão em grupos
notingroup string

Recupere usuários que não estão em nenhum grupo.

Tipo de ordem de classificação
ordertype string

Classifique os usuários por um campo especificado, como nome, organização ou status.

Ordem de classificação
orderby string

A classificação resulta em ordem crescente ou decrescente.

ID externo
externalid string

Filtre usuários por ID externo.

Nome Próprio
firstname string

Filtre os usuários pelo nome.

Apelido
lastname string

Filtre os usuários por sobrenome.

Endereço de E-mail
email string

Filtre os usuários por endereço de e-mail.

Pesquisa de Utilizadores
search string

Pesquise usuários por vários atributos, incluindo nome, e-mail e cargo.

Filtro do alfabeto
alphabets string

Filtre usuários cujo sobrenome comece com uma letra específica.

Cargo
jobtitle string

Filtre os usuários por cargo.

Localização
locations string

Filtre os utilizadores por cidade.

Departamento
departments string

Filtre usuários por departamento.

Nome da Organização
organisations string

Filtre os usuários por nome da organização.

Especialidades
specialities string

Filtre os utilizadores pelas suas especialidades.

Pesquisa de administradores do sistema
systemAdminSearch string

Recupere usuários com a função de administrador do sistema.

Devoluções

Body
users

Recuperar uma lista de itens do iSheet

Esta chamada de API recupera uma lista de itens contidos no iSheet especificado.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Especifica a versão da API que está sendo usada.

ID do iSheet
isheetid True integer

Especifica o ID exclusivo do iSheet.

ID do iSheet View
sheetviewid integer

Especifica a ID do modo de exibição do iSheet. Se omitido, o modo de exibição padrão será retornado.

ID da coluna de classificação
sortcolumnid integer

Especifica a ID da coluna usada para classificar os resultados.

Ordem de classificação
sortorder integer

Especifica a ordem de classificação. Por exemplo, use 0 para ordem crescente ou outro valor para ordem decrescente.

Limite de registros
limit integer

Especifica o número máximo de registros a serem retornados; O valor padrão é 100 se não for especificado.

Deslocamento de registros
offset integer

Especifica a posição inicial para recuperação de registros; o padrão é 0 se não for especificado.

Incluir todas as colunas
allColumnRequired boolean

Um sinalizador que indica se todos os dados da coluna devem ser incluídos, independentemente do modo de exibição atual.

Ignorar restrições de exibição
isIgnoreView boolean

Um sinalizador que indica se as restrições de exibição devem ser ignoradas ao recuperar dados de item.

Devoluções

Name Caminho Tipo Description
isheet
isheet array of object

Uma lista de itens do iSheet.

itemId
isheet.itemId string

A ID exclusiva do item.

dados
isheet.data array of object

Dados detalhados do item.

sequência
isheet.data.sequence string

O número de sequência associado aos dados.

columnDisplayName
isheet.data.columnDisplayName string

O nome para exibição da coluna.

valor
isheet.data.value string

O valor contido na coluna.

Recuperar uma lista de pastas

Esta chamada de API recupera uma lista de pastas contidas na pasta especificada. O parâmetro 'limit' define o número máximo de itens a retornar e o parâmetro 'offset' especifica a posição inicial para a recuperação de dados. Os valores padrão são aplicados se esses parâmetros forem omitidos e as pastas forem retornadas em ordem crescente por data de criação.

Parâmetros

Name Chave Necessário Tipo Description
Versão da API
version True string

Especifica a versão da API que está sendo usada.

ID da pasta
folderid True string

Especifica a ID exclusiva da pasta.

Limite de itens
limit string

Especifica o número máximo de itens a serem devolvidos.

Deslocamento de itens
offset string

Especifica a posição inicial para os itens retornados.

Direção da ordem de classificação
orderby string

Especifica a direção da ordem para classificar itens. Use 'asc' para ordem crescente ou 'desc' para ordem decrescente.

Critério de classificação
ordertype string

Especifica o critério para classificar itens, como nome, autor ou data da última modificação.

Incluir informações de status da pasta
statusinfo boolean

Indica se as informações adicionais de status da pasta devem ser incluídas. O valor predefinido é false.

Incluir pastas inteligentes
includesmartfolder boolean

Indica se as pastas inteligentes devem ser incluídas na lista retornada. O valor predefinido é false.

Devoluções

Name Caminho Tipo Description
pasta
folder array of object
items
folder object

Definições

ErrorDBO

Name Caminho Tipo Description
resumo
summary string
refª
ref string
ligação
link string

Banco de Dados de Documentos

Name Caminho Tipo Description
Docid
docid string

ID do documento.

columns

Name Caminho Tipo Description
coluna
column array of object
items
column object

LocalizaçãoDBO

Name Caminho Tipo Description
endereço1
addressline1 string

Primeira linha do endereço.

endereço2
addressline2 string

Segunda linha do endereço.

endereço3
addressline3 string

Terceira linha do endereço.

city
city string

Cidade do endereço.

state
state string

Estado do endereço.

country
country string

País do endereço.

código postal
postcode string

Código postal do endereço.

Nome de Utilizador

Name Caminho Tipo Description
title
title string

Título do utilizador.

Nome próprio
firstname string

Nome próprio do utilizador.

Apelido
lastname string

Apelido do utilizador.

Goesby
goesby string

nome preferencial do usuário.

MetadataListDBO

Name Caminho Tipo Description
MetadataName
metadataname array of string
valor dos metadados
metadatavalue array of string
Name Caminho Tipo Description
id
id string

Link ID

nome
name string

Nome do link.

valor
value string

Valor do link.

Name Caminho Tipo Description
ligação
link array of NameValueLink

ExperiênciasDBO

Name Caminho Tipo Description
experiência
experience array of string

GruposDBO

Name Caminho Tipo Description
agrupar
group array of string

utilizador

Name Caminho Tipo Description
ID de usuário
userid integer

ID de Utilizador.

a seguir
following boolean

Seguindo.

e-mail
email string

Endereço de e-mail.

nome
name UserName
link de usuário
userlink string

Link do usuário.

Ligação http
httplink string

Link HTTP.

httpavatar
httpavatar string

Avatar HTTP.

Avatar
avatar integer

Avatar do usuário.

ExternalID
externalid string

ID externo.

data de nascimento
dateofbirth string

Data de nascimento.

phone
phone string

Número de telefone.

cargo:
jobtitle string

Cargo.

móvel
mobile string

Número de telemóvel.

departamento
department string

Departamento.

estado
status string

Estado.

organização
org string

Organização.

orgName
orgName string

Nome da Organização.

localização
location LocationDBO
IMG
img string

Imagem.

experiências
experiences ExperiencesDBO
Ligações sociais
sociallinks Link
link personalizado
customlink Link
link de mensagens
messaginglink Link
nome do secretário
secretaryname string

Nome do Secretário.

correio de secretária
secretarymail string

Correio do Secretário.

biografia
bio string

Biografia do utilizador.

Tipo de fonte
sourcetype string

Tipo de fonte.

Especialidades
specialities string

Especialidades.

relatóriospara
reportsto string

Usuário para o qual o usuário atual se reporta.

metadados
metadata MetadataListDBO
groups
groups GroupsDBO
sufixo
suffix string

Sufixo do nome do usuário.

atomlink
atomlink string

Link Atom associado ao usuário.

ligação
link string

Link associado ao usuário.

loggeduserlike
loggeduserlike integer

Contagem de gostos do utilizador com sessão iniciada.

nome de utilizador
userName string

Nome de Usuário.

users

Name Caminho Tipo Description
utilizador
user array of user

PastaDBOV1

Name Caminho Tipo Description
FolderID
folderid string

O identificador exclusivo da pasta criada.

DmsDBO

Name Caminho Tipo Description
dmsfolderid
dmsfolderid string

O identificador de pasta DMS.

dmsParentFolderID
dmsParentFolderID string

O identificador da pasta pai DMS.

dmscreateddate
dmscreateddate date-time

A data em que a pasta DMS foi criada.

dmsmodifiedPor
dmsmodifiedBy string

O usuário que modificou pela última vez a pasta DMS.

dmsdatabasename
dmsdatabasename string

O nome do banco de dados DMS.

DMSlink
dmslink boolean

Indica se um link DMS está disponível.

DMSLinkby
dmslinkby string

O usuário que vinculou a pasta DMS.

grupo de sites

Name Caminho Tipo Description
nome
name string
id
id integer
copypermissionsfrom
copypermissionsfrom string
mensagem
message string
typeID
typeID integer
tipo
type string
Número de utilizadores
numberofusers string
criado
created string
modified
modified string
systemGroupID
systemGroupID integer
descrição
description string
basicusergroup
basicusergroup integer

Address

Name Caminho Tipo Description
endereçoid
addressid string

Identificador exclusivo do endereço.

endereço1
addressline1 string

Primeira linha do endereço.

endereço2
addressline2 string

Segunda linha do endereço.

endereço3
addressline3 string

Terceira linha do endereço.

city
city string

Cidade do endereço.

state
state string

Estado do endereço.

country
country string

País do endereço.

Código postal
postCode string

Código postal do endereço.

conhecido como
knownas string

Nome ou alcunha alternativos para a morada.

IntegrationUserDBO

Name Caminho Tipo Description
indexar
index integer

Índice exclusivo para o usuário.

ID de usuário
userid integer

Identificador exclusivo para o usuário.

Nome próprio
firstname string

Nome próprio do utilizador.

Apelido
lastname string

Apelido do utilizador.

grupo de prática
practicegroup string

Grupo de prática ao qual o usuário pertence.

código de lang
langcode string

Código linguístico do utilizador.

localeID
localeID string

ID de localidade do usuário.

perfil público
publicprofile string

Perfil público do utilizador.

pwpid
pwpid string

ID PWP do usuário.

usertypeid
usertypeid string

ID do tipo de usuário.

systemuser
systemuser string

Sinalizador de usuário do sistema.

e-mail
email string

Endereço de e-mail do usuário.

phone
phone string

Número de telefone do utilizador.

móvel
mobile string

Número de telemóvel do utilizador.

departamento
department string

Departamento do usuário.

organização
org string

Organização à qual o usuário pertence.

localização
location LocationDBO
address
address Address
experiências
experiences ExperiencesDBO
Ligações sociais
sociallinks Link
link de mensagens
messaginglink Link
link personalizado
customlink Link
IMG
img string
relatóriospara
reportsto string
metadados
metadata MetadataListDBO
groups
groups GroupsDBO
ExternalID
externalid string

ID externo do utilizador.

cargo:
jobtitle string

Cargo do usuário.

nome do secretário
secretaryname string

Nome do secretário do usuário.

correio de secretária
secretarymail string

E-mail da secretária do usuário.

Especialidades
specialities string

Especialidades do utilizador.

title
title string

Título do utilizador.

Goesby
goesby string

nome preferencial do usuário.

sufixo
suffix string

Sufixo do nome do usuário.

atomlink
atomlink string

Link Atom associado ao usuário.

biografia
bio string

Biografia do utilizador.

dateOfBirth
dateOfBirth string

Data de nascimento do utilizador.

ligação
link string

Link associado ao usuário.

estado
status string

Status do usuário.

código de estado
statuscode string

Código de status do usuário.

mensagem
message string

Mensagem associada ao utilizador.

Tipo de fonte
sourcetype string

Tipo de origem do usuário.

Orgid
orgid string

ID da organização.

ifpartner
ifpartner string

Bandeira de parceiro.

emaildomain
emaildomain string

Domínio de e-mail do usuário.

conviteenviado
invitationsent string

Bandeira de convite enviado.

criado por
createdby string

Usuário que criou o registro.

data de criação
createddate string

Data em que o registo foi criado.

modificadopor
modifiedby string

Usuário que modificou o registro.

data modificada
modifieddate string

Data em que o registo foi modificado.

LastLoginDate
lastlogindate string

Data do último login.

logins inválidos
invalidlogins string

Contagem de tentativas de login inválidas.

publicwebsiteprofileid
publicwebsiteprofileid string

ID do perfil do site público.

ResetPasswordDate
resetpassworddate string

Data em que a palavra-passe foi reposta.

Avatar
avatar string

URL da imagem do avatar.

contagem de seguidores
followingcount integer

Contagem de usuários sendo seguidos.

contagem de seguidores
followercount integer

Contagem de seguidores.

a seguir
following boolean

Seguindo a bandeira.

função
role string

Papel do utilizador.

isbasicuser
isbasicuser string

Sinalizador de usuário básico.

encryptedUserId
encryptedUserId string

ID de utilizador encriptado.

auto-registado
selfregistered integer

Bandeira auto-registrada.

registadoWith2FA
registeredWith2FA string

Sinalizador de registro de autenticação de dois fatores.

isInterno
isInternal integer

Sinalizador de usuário interno.

orgName
orgName string

Nome da organização.

site

Name Caminho Tipo Description
id
id integer

O identificador do site.

nome do site
sitename string

O nome do site.

função
role string

O papel do site.

Descrição do site
sitedescription string

A descrição do site.

módulos habilitados
enabledmodules string

Uma lista de módulos habilitados para o site.

sitefolderID
sitefolderID string

O identificador da pasta do site.

sitefolderpermission
sitefolderpermission string

O nível de permissão para a pasta do site.

módulo
module ModuleDBO
nota de administrador
adminnote string

Notas administrativas relacionadas com o site.

data de início
startdate string

A data de início da operação do site.

Data de fim
enddate string

A data final do funcionamento do site.

data de criação
createddate string

A data em que o site foi criado.

data de arquivo
archiveddate string

A data em que o site foi arquivado.

clienteno
clientno string

O número de cliente associado ao site.

não importa
matterno string

O número da matéria associada ao site.

página de aterragem
landingpage string

O URL da página de destino do site.

ligação
link string

Um link relacionado ao site.

estado
status string

O status atual do site.

StatusID
statusid integer

O identificador do status do site.

size
size string

O tamanho do site.

notas de faturação
billingnotes string

Notas relacionadas com a faturação do site.

faturamentopróximodata da fatura
billingnextinvoicedate string

A data da próxima fatura do site.

billinglastinvoicedate
billinglastinvoicedate string

A data da última fatura do site.

FilePageCount
filepagecount string

A contagem total de páginas de arquivos no site.

MaxPageCount
maxpagecount string

A contagem máxima de páginas permitida para arquivos no site.

sítiohttplink
sitehttplink string

O link HTTP para o site.

isSyncable
isSyncable integer

Indica se o site é sincronizável.

EnforceUserGroups
enforceusergroups string

Os grupos de usuários impostos para o site.

csvSiteCategory
csvSiteCategory string

A categoria do site em formato CSV.

siteNameInDefaultLanguage
siteNameInDefaultLanguage string

O nome do site no idioma padrão.

visível
visible integer

Indica se o site está visível.

siteLogoName
siteLogoName string

O nome do arquivo de logotipo do site.

siteLogoFileSize
siteLogoFileSize integer

O tamanho do arquivo do logotipo do site.

siteLogoHeight
siteLogoHeight integer

A altura do logotipo do site.

siteLogoWidth
siteLogoWidth integer

A largura do logotipo do site.

Estado do site
siteStatus integer

O código de status do site.

applyTermos do Site
applySiteTerms integer

Indica se os termos do site são aplicados.

siteTerm
siteTerm string

Os termos aplicam-se ao site.

termType
termType integer

O tipo de termos aplicados ao site.

nextLoginSiteTermos
nextLoginSiteTerms integer

Indica se os termos do site são necessários no próximo login.

defaultSiteTermsEnable
defaultSiteTermsEnable integer

Indica se os termos padrão do site estão habilitados.

advancedQAPermission
advancedQAPermission integer

O nível de permissão de QA avançado para o site.

isInterno
isInternal integer

Indica se o site é interno.

PSM
psm integer

O identificador do Product Service Manager.

siteLabelDisplay
siteLabelDisplay string

O rótulo de exibição do site.

allowSiteAdministration
allowSiteAdministration integer

Indicar se a administração do local é permitida.

siteLevelPasswordEnable
siteLevelPasswordEnable integer

Para ativar a proteção por senha no nível do site.

siteLevelPasscodeEnable
siteLevelPasscodeEnable integer

Para ativar a proteção por código no nível do site.

código de acessoUsingAuthApp
passcodeUsingAuthApp integer

Indica se a autenticação por senha usa um aplicativo de autenticação.

sitePassword
sitePassword string

A palavra-passe associada ao site.

ipRestrictionEnable
ipRestrictionEnable integer

Para habilitar restrições de IP para acesso ao site.

disponívelIP
availableIP string

Lista separada por vírgulas dos endereços IP autorizados a aceder ao site.

highqDrive [en]
highqDrive integer

Indica se a integração do HighQ Drive está ativada.

applySiteHomePage
applySiteHomePage integer

Para aplicar uma home page personalizada para o site.

sitePágina inicial
siteHomePage string

URL da home page personalizada do site.

siteHomePageType
siteHomePageType integer

Tipo da página inicial.

próximoLoginSiteHomePage
nextLoginSiteHomePage integer

Para definir o próximo login na página inicial do site.

aplicarDisplayContent
applyDisplayContent integer

Para aplicar as configurações de conteúdo de exibição.

displayContent
displayContent string

Conteúdo para exibir no site.

rssSegurança
rssSecurity integer

Nível de segurança do feed RSS.

encryptedPassword
encryptedPassword integer

Indica se a senha do site está criptografada.

disponívelIPRangeCSV
availableIPRangeCSV string

Lista separada por vírgulas de intervalos de endereços IP permitidos para acessar o site.

siteModuleID
siteModuleID integer

Identificador do módulo do site.

icalSegurança
icalSecurity integer

Nível de segurança do feed iCal.

defaultDisplayContent
defaultDisplayContent string

Conteúdo padrão a ser exibido no site.

defaultEmailAlert
defaultEmailAlert integer

Para ativar alertas de e-mail padrão.

excelReportFooter
excelReportFooter integer

Inclui um rodapé nos relatórios do Excel.

excelReportFooterText
excelReportFooterText string

Texto a apresentar no rodapé dos relatórios do Excel.

anúncioMLJSON
announcementMLJSON string

Anúncios formatados em JSON para o site.

modeloTipo
templateType integer

Tipo de modelo usado para o site.

templateLicence
templateLicence integer

Tipo de licença para o modelo de site.

openChannelAppID
openChannelAppID string

ID do aplicativo para a integração de canal aberto.

itemid
itemid integer

Identificador do item associado ao site.

SiteMetaDataSheetID
sitemetadatasheetid integer

ID da folha de metadados associada ao site.

mysite
mysite boolean

Indica se este é o site pessoal do usuário.

data de acesso último
lastaccesseddate string

Data e hora em que o site foi acessado pela última vez.

defaultViewerMetaDataTab
defaultViewerMetaDataTab integer

Guia de metadados padrão para o visualizador do site.

documentMetadataViewId
documentMetadataViewId integer

metadados do documento para identificador de visualização.

pastaMetadataViewId
folderMetadataViewId integer

metadados de pasta para identificador de exibição.

docSort
docSort integer

A ordem de classificação dos documentos.

folderSort
folderSort integer

A ordem de classificação das pastas.

defaultFolderRenderView
defaultFolderRenderView integer

Determina o modo de exibição padrão para pastas.

isTaskAttachmentDefault
isTaskAttachmentDefault integer

O local padrão para anexos de tarefas.

taskAttachmentDefaultFolderId
taskAttachmentDefaultFolderId integer

O identificador exclusivo da pasta designada como o local padrão para anexos de tarefas.

favorito
favourite string

status favorito.

enabledocumentredaction
enabledocumentredaction boolean

Especifica se a redação de documentos está habilitada para o site.

grupos de menção
mentiongroups integer

Os grupos mencionados.

EnableFileRelationships
enablefilerelationships boolean

Indica se as relações de arquivo estão habilitadas.

FileRelationshipSitePermissionLevel
filerelationshipsitepermissionlevel integer

O nível de permissão necessário para gerenciar relações de arquivo.

ModuleDBO

Name Caminho Tipo Description
Casa
home HomeDBO
actividade
activity ActivityDBO
documento
document DocumentDBO
blogue
blog BlogDBO
wiki
wiki WikiDBO
tarefa
task TaskDBO
evento
event EventDBO
isheet
isheet ISheetDBO
QA
qa QaDBO
Pessoas
people PeopleDBO
contractexpress
contractexpress ContractExpressDBO

HomeDBO

Name Caminho Tipo Description
activar
enable string

Habilite o status para HomeDBO.

ActivityDBO

Name Caminho Tipo Description
activar
enable string

Habilite o status para ActivityDBO.

microblog
microblog string

Conteúdo de microblog associado ao ActivityDBO.

BlogDBO

Name Caminho Tipo Description
blogTítulo
blogTitle string

Título da postagem do blog.

blogConteúdo
blogContent string

Conteúdo da postagem do blog.

showComment
showComment integer

mostrar o comentário.

tagLista
tagList array of string

Lista de tags associadas ao blog.

estado
status integer

status da postagem do blog.

ID do site
siteID integer

Identificador do site associado.

autor
author string

Autor do blog.

categoryList
categoryList array of string

Categorias atribuídas à postagem do blog.

notificationTypeID
notificationTypeID integer

Identificador do tipo de notificação.

mensagem
message string

Conteúdo da mensagem relacionado ao blog.

Código da mensagem
messageCode integer

Código associado à mensagem.

ID externo
externalID string

Identificador externo vinculado ao blog.

publicarData
publishDate string

Data de publicação do blog.

tipo de processo
processtype string

Tipo de processo associado ao blog.

activar
enable string

Habilite o status para BlogDBO.

WikiDBO

Name Caminho Tipo Description
Wikiid
wikiid integer

Identificador exclusivo para o wiki.

CurrentVersionID
currentversionid integer

Identificador da versão atual do wiki

parentwikiid
parentwikiid integer

Identificador do wiki pai.

título wiki
wikititle string

Título da wiki.

conteúdo wiki
wikicontent string

Conteúdo da wiki.

showcomment
showcomment integer

Indicando se os comentários estão habilitados.

data de criação
createddate string

Data de criação da wiki.

data modificada
modifieddate string

Data da última modificação da wiki.

Lista de tags
taglist string

Lista separada por vírgulas de tags associadas ao wiki.

Wikicaminho
wikipath string

Caminho para acessar o wiki.

WikiDraftID
wikidraftid integer

Identificador da versão preliminar do wiki.

Tipo de rascunho
drafttype string

Tipo de rascunho associado ao wiki.

estado
status integer

Status atual do wiki.

WikiVersionID
wikiversionid integer

Identificador de versão do wiki.

TaskDBO

Name Caminho Tipo Description
indexar
index string

Índice ou identificador da tarefa.

ParentTaskID
parenttaskid integer

Identificador da tarefa pai.

TaskID
taskid integer

Identificador exclusivo da tarefa.

title
title string

Título da tarefa.

descrição
description string

Descrição detalhada da tarefa.

Data de vencimento
duedate string

Data de conclusão da tarefa.

data de início
startdate string

Data de início em que a tarefa foi iniciada.

MatterMapTaskID
mattermaptaskid string

Identificador vinculado à tarefa de mapa de matéria.

tipo
type string

Tipo ou categoria da tarefa.

dependente
dependenton string

Tarefas das quais esta tarefa depende.

diasdedependentes
daysfromdependent string

Número de dias da tarefa dependente.

ignorarfim de semana
ignoreweekend integer

Indica se os fins de semana são ignorados na programação.

duration
duration integer

Duração para concluir a tarefa.

recurso
resource string

Recursos atribuídos à tarefa.

EventDBO

Name Caminho Tipo Description
eventoTítulo
eventTitle string

Título do evento.

eventoConteúdo
eventContent string

Conteúdo do evento.

showComment
showComment integer

Indicando se os comentários estão habilitados para o evento.

tagLista
tagList array of string

Lista de tags associadas ao evento.

estado
status integer

Estado atual do evento.

ID do site
siteID integer

Identificador do site.

contacto
contact string

Informações de contacto para o evento.

categoryList
categoryList array of string

Categorias sob as quais o evento está listado.

notificationTypeID
notificationTypeID integer

O tipo de notificação relacionado ao evento.

mensagem
message string

A mensagem do evento.

Código da mensagem
messageCode integer

O código da mensagem do evento.

ID externo
externalID string

O identificador externo.

startDate
startDate string

A data de início do evento.

data de término
endDate string

A data final do evento.

startTime
startTime string

A hora de início do evento.

endTime
endTime string

A hora de término do evento.

localização
location string

O local do evento.

autor
author string

O autor do evento.

tipo de processo
processtype string

O tempo de processo do evento.

activar
enable string

Habilitar o evento.

ISheetDBO

Name Caminho Tipo Description
id
id integer

Identificador exclusivo do iSheet.

title
title string

Título do iSheet.

descrição
description string

Descrição do isheet.

estado
status string

Estado do isheet.

tipo de acesso
accesstype string

Tipo de acesso do isheet.

tipo
type string

Tipo de isheet.

Ver link
viewlink string

Link para visualizar o iSheet.

allowsections
allowsections string

Se as seções são permitidas.

PermitirPesquisa
allowlookup string

Se os campos de pesquisa estão habilitados.

displayisheet
displayisheet string

Opções de exibição para o iSheet.

SearchAsDefaultView
searchasdefaultview string

Indica se a pesquisa é o modo de exibição padrão.

enableversion
enableversion string

Sinalizador de controle de versão habilitado.

EnableSheetAlerter
enablesheetalerter string

Sinalizador para ativar alertas de folha.

alertercondition
alertercondition string

Condições para acionar alertas.

OverrideItemModifiedDate
overrideitemmodifieddate string

Substituir sinalizador de data modificado.

EnableBulkInsertUpdate
enablebulkinsertupdate string

Habilite a inserção/atualização em massa.

descrições de campo
fielddescriptions string

Descrições de campos para o iSheet.

EnableRowLocking
enablerowlocking string

Habilite o bloqueio em nível de linha.

setcharlimittruncatemultilinetextenabled
setcharlimittruncatemultilinetextenabled string

Truncar sinalizador de texto de várias linhas.

setcharlimittruncatemultilinetextval
setcharlimittruncatemultilinetextval string

Limite de caracteres para truncamento de várias linhas.

allowchoicelistvaluesforreuse
allowchoicelistvaluesforreuse string

Permitir a reutilização dos valores da lista de opções.

allowscorelistvaluesforreuse
allowscorelistvaluesforreuse string

Permitir a reutilização dos valores da lista de pontuações.

allowIsheetComentários
allowIsheetComments string

Permitir comentários no iSheet.

shareRecordsLimit
shareRecordsLimit integer

Limite de registos permitidos a partilhar.

shareRecordsLimitEnabled
shareRecordsLimitEnabled integer

Limite de compartilhamento de registros habilitado.

enableIsheetAddRecordFormSharing
enableIsheetAddRecordFormSharing string

Habilite o compartilhamento de formulários para adicionar registros.

contagem de recordes
recordcount string

Contagem recorde atual.

sheettypeid
sheettypeid integer

ID do tipo do iSheet

QaDBO

Name Caminho Tipo Description
activar
enable string

Habilite a funcionalidade de controle de qualidade.

PessoasDBO

Name Caminho Tipo Description
pessoa
person array of PersonDBO

PersonDBO

Name Caminho Tipo Description
ID de usuário
userid integer

ID de Utilizador.

e-mail
email string

endereço de e-mail.

httpavatar
httpavatar string

URL HTTP do avatar.

Avatar
avatar string

Imagem do avatar.

link de usuário
userlink string

Link para o perfil do usuário.

Ligação http
httplink string

Link HTTP para o perfil do usuário.

phone
phone string

Número de telefone.

móvel
mobile string

Número de telemóvel.

departamento
department string

Departamento do utilizador.

ContractExpressDBO

Name Caminho Tipo Description
activar
enable string

Habilite a integração do Contract Express.

PastaDBOV2

Name Caminho Tipo Description
nome
name string

Nome da pasta.

descrição
description string

Descrição da pasta.

parentFolderID
parentFolderID integer

ID da pasta pai.

accessHerdado
accessInherited integer

Acessar o status da herança.

ID do lote
batchID string

Identificador de lote

DMS
dms DmsDBO
id
id integer

ID da pasta.

ligação
link string

Link da pasta.

data de criação
createddate string

Data de criação.

data modificada
modifieddate string

Data de modificação.

elemento subordinado
child integer

Pastas filhas.

contagem de arquivos
filecount integer

Número de ficheiros.

criado por
createdby UserDBO
modificadopor
modifiedby UserDBO
FolderID
folderid integer

ID da pasta.

dmsfolderid
dmsfolderid string

Identificador da pasta DMS.

SiteID
siteid integer

ID do Site

localização
location string

Localização da pasta.

permissão
permission PermissionDBO
status de conteúdo
contentstatus integer

Status do conteúdo.

Numeração automática
autonumbering string

Configuração de numeração automática.

tamanho da pasta
foldersize string

Tamanho da pasta.

status compartilhado
sharedstatus integer

Estado de partilha.

status favorito
favouritestatus integer

Estatuto favorito.

tipo de pasta
foldertype string

Tipo de pasta.

itemId
itemId integer

ID do item.

folderMetadataSheetId
folderMetadataSheetId integer

Metadados da pasta do ID da folha.

UserDBO

Name Caminho Tipo Description
Nome próprio
firstname string

Nome próprio.

Apelido
lastname string

Apelido.

e-mail
email string

Endereço de e-mail.

ID de usuário
userid integer

ID de Utilizador.

PermissionDBO

Name Caminho Tipo Description
vista
view integer

Ver Permissão.

editar
edit integer

Permissão de edição.

eliminar
delete integer

Excluir permissão.

addEditAllFiles
addEditAllFiles integer

Permissão Adicionar/Editar Todos os Ficheiros.

admin
admin integer

Permissão de administrador.

viewAllFiles
viewAllFiles integer

Ver todos os ficheiros Permissão.

desativarSalvar
disableSave integer

desative a permissão de salvamento.

carregarFicheiro
uploadFile integer

Permissão de upload de arquivo.

updateFile
updateFile integer

Permissão de atualização do arquivo.

deleteFile
deleteFile integer

Excluir permissão de arquivo.

ProgressiveKeyDBO

Name Caminho Tipo Description
Chave Progressiva
progressivekey string

Chave para operações progressivas.

SiteID
siteid integer

Identificador do site.

progressivekeystatus
progressivekeystatus string

Status da chave progressiva.

ID de usuário
userid integer

Identificador do usuário.

corpo de resposta
responsebody string

Corpo da resposta.

mensagem
message string

Conteúdo da mensagem.

código de mensagem
messagecode string

Código associado à mensagem.

integrationResponseDBO
integrationResponseDBO IntegrationResponseDBO
columns
columns ColumnErrorsDBO
items
items ItemErrorsDBO
importisheettemplate
importisheettemplate importISheetTemplateDBO
erro
error ErrorDBO
TipoDeConteúdo
contentType string

Tipo de conteúdo.

failedEntidades
failedEntities integer

Número de entidades com falha.

link para download
downloadlink string

Link para download de conteúdo.

Acessório
attachment Attachment
ligação
link string

Link associado.

ID do documento
documentid integer

Identificador do documento.

ProgressKey
progresskey string

Chave de progresso para rastreamento.

ProgressKeyStatus
progresskeystatus string

Status da chave de progresso.

IntegrationResponseDBO

Name Caminho Tipo Description
integrationResponseUsersObject
integrationResponseUsersObject IntegrationResponseUsersObject
failedEntidades
failedEntities integer

Número de entidades que falharam no processamento.

sucessoEntidades
successEntities integer

Número de entidades que foram processadas com sucesso.

IntegrationResponseUsersObject

Name Caminho Tipo Description
utilizador
user array of IntegrationUserDBO

ColumnErrorsDBO

Name Caminho Tipo Description
coluna
column array of ColumnErrorDBO
failedEntidades
failedEntities integer

Número de entidades que falharam devido a erros de coluna.

sucessoEntidades
successEntities integer

Número de entidades que foram processadas com sucesso.

ColumnErrorDBO

Name Caminho Tipo Description
indexar
index integer

Posição do índice da coluna com erro.

columnid
columnid integer

Identificador exclusivo da coluna com erro.

nome
name string

Nome da coluna com erro.

estado
status string

Status que indica a condição de erro.

código de estado
statuscode string

Código que representa o status de erro.

mensagem
message string

Mensagem de erro detalhada.

ItemErrorsDBO

Name Caminho Tipo Description
item
item array of ItemErrorDBO
failedEntidades
failedEntities integer

Número de entidades que falharam devido a erros de item.

sucessoEntidades
successEntities integer

Número de entidades que foram processadas com êxito apesar dos erros do item.

ItemErrorDBO

Name Caminho Tipo Description
indexar
index integer

Posição do índice do item com erro.

columns
columns ColumnErrorsDBO
itemid
itemid string

Identificador exclusivo do item com erro.

ExternalID
externalid string

Identificador externo associado ao item.

id
id string

Identificador interno do item.

nome
name string

Nome do item com erro.

estado
status string

Status que indica a condição de erro.

código de estado
statuscode string

Código que representa o status de erro.

mensagem
message string

Mensagem de erro detalhada.

successdeletedcount
successdeletedcount integer

Contagem de entidades excluídas com êxito.

Contagem de falhas
failurecount integer

Contagem de entidades que falharam no processamento.

failedEntidades
failedEntities integer

Número de entidades que falharam devido a erros de item.

sucessoEntidades
successEntities integer

Número de entidades que foram processadas com sucesso.

importISheetTemplateDBO

Name Caminho Tipo Description
LinkedTemplateID
linkedtemplateid integer

Identificador do modelo vinculado.

aliasname
aliasname string

Nome do alias para o modelo.

Linkedisheet
linkedisheet string

Identificador da folha de entrada vinculada.

ImportData
importdata string

Dados a serem importados do modelo.

appendisheetname
appendisheetname string

Nome da folha à qual acrescentar dados.

templateparametergroups
templateparametergroups ISheetTemplateParameterGroups
templateSheetIdMap
templateSheetIdMap object
templateId
templateId integer

Identificador do modelo.

templateTitle
templateTitle string

Título do modelo.

viewIDs
viewIDs string

Lista de IDs de exibição separada por vírgula.

ISheetTemplateParameterGroups

Name Caminho Tipo Description
templateparametergroup
templateparametergroup array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name Caminho Tipo Description
TemplateRuleId
templateruleid integer

Grupo de Parâmetros de Modelo do Isheet.

templateparameter
templateparameter array of ISheetTemplateParameter

ISheetTemplateParameter

Name Caminho Tipo Description
id
id integer

Identificador do parâmetro de modelo isheet.

nome
name string

Nome do parâmetro de modelo isheet.

dados
data string

Dados do parâmetro iSheet Template.

Attachment

Name Caminho Tipo Description
ficheiro
file string

O conteúdo do arquivo.

nome
name string

O nome do anexo.

order
order string

A ordem da penhora.

id
id integer

Identificador exclusivo do anexo.

extensão
extension string

Extensão de arquivo.

ParentFolderID
parentfolderid integer

ID da pasta pai.

filehttplink
filehttplink string

Link HTTP para acessar o arquivo.

caminho da pasta
folderpath string

Caminho para a pasta que contém o arquivo.

pastahttplink
folderhttplink string

Link HTTP para a pasta.

tamanho do ficheiro
filesize integer

Tamanho do ficheiro em bytes.

redactionStatus
redactionStatus boolean

Indica se o arquivo está redigido.

displayname
displayname string

Nome para exibição do anexo.

SiteID
siteid integer

ID do site associado ao anexo.