HighQ (versão prévia)

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 dá suporte à automação de documentos, à sincronização de dados e à orquestração de fluxo de trabalho, capacitando as equipes de serviços legais e profissionais a simplificar as operações, reduzir o esforço manual e aumentar a produtividade.

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

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Highq
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email	highq-support@thomsonreuters.com

Metadados do conector
Publicador	Thomson Reuters Incorporated
Site da 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 arquivos

HighQ

Visão geral

O HighQ fornece acesso contínuo, seguro e autenticado às APIs HighQ. Esse conector permite interação perfeita com vários serviços HighQ, incluindo o Módulo ISheet, APIs de Recurso de Documento, API de Administrador do 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 iSheet, gerenciar arquivos de documentos e administrar contas de usuário.

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

Authentication

O conector utiliza variáveis de ambiente dinâmicas para conectividade segura:

Host: @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 do HighQ ou entre em contato com o suporte do HighQ.

Operações do conector

Módulo ISheet

Recuperar itens do iSheet
GET /{version}/isheet/{isheetid}/items
Recupera uma lista de itens dentro da iSheet especificada.
Criar Itens do iSheet
POST /{version}/isheet/{isheetid}/items
Insere novos itens em uma iSheet, com suporte para várias iSheets e acompanhamento de status por meio de chaves progressivas.

APIs de recurso de documento

Recuperar informações do arquivo
GET /{version}/files/{fileid}
Recupera informações detalhadas sobre um arquivo específico na plataforma HighQ Collaborate.
Carregar um arquivo
POST /{version}/files/content
Carrega um arquivo em uma pasta especificada, dando suporte a uploads 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 iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Recupera as 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.

Gerenciamento de Documentos e Sites

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 no mesmo site.
Operações de Gerenciamento de 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

Configuração:
- Defina as variáveis highqt_host de ambiente e highqt_instancename em seu ambiente do Power Platform.
Autenticação:
- Siga as diretrizes fornecidas pelo HighQ para configurar a autenticação segura para solicitações de API.
Uso:
- Importe o HighQ para sua instância do Power Platform.
- Utilize as operações disponíveis conforme necessário. Consulte os resumos de operação fornecidos acima para obter diretrizes.

Parâmetros e configurações

Parâmetros de caminho:
Inclua parâmetros necessários, como version, isheetid, fileide folderiduserid conforme aplicável.
Parâmetros de consulta:
Parâmetros opcionais, como sheetviewid, sortcolumnidlimite offset estão disponíveis para refinar respostas de API.
Parâmetros do corpo:
Para operações que exigem um corpo da solicitação (por exemplo, criação de itens ou usuários do iSheet), verifique se a solicitação segue os esquemas definidos (como isheetDBO, FolderDBOou IntegrationUserDBO).

Solução de problemas e limitações

Códigos de erro:
Códigos de status HTTP padrão são usados entre operações:
- 200 para operações bem-sucedidas
- 401 para acesso não autorizado
- 403 por falhas de validação ou proibidas
- 405 para métodos HTTP inválidos
- 500 para erros internos do servidor
  Consulte a documentação da API individual para obter descrições detalhadas de erro.
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 estendida, consulte:

Suporte técnico do HighQ
Documentação interna que acompanha o pacote do conector HighQ.

Licenciamento e suporte

Para obter detalhes de licenciamento e suporte técnico:

Contato: Highq
URL de suporte: Suporte técnico highq
Email de suporte: highq-support@thomsonreuters.com

Limitações

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

Ações

Adicionar grupo existente ao site

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

Adicionar site

Use essa API para criar um novo site. O objeto do site só dá suporte a atributos visíveis na interface do site create.

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

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

Esse método não dá suporte ao carregamento de imagem do site nesta chamada, o suporte ao ícone de site será fornecido como uma chamada separada.
A chamada de método espera uma ID de categoria existente. A ID da categoria deve ser obtida pelo aplicativo de chamada por uma chamada anterior para a interface de categorias de site. Se nenhuma categoria for fornecida na solicitação, nenhuma categoria (nenhuma categoria real) será adicionada por padrão.

A data de início e término do site deve estar no formato 'dd MMM yyyyy' e não é UTC. O cliente de API sempre solicitará a data real.

"landingpage" tem o valor padrão como "arquivos (pasta raiz)".
A "página de aterrissagem" espera três textos ou identificações diferentes para o módulo Arquivo. Os valores possíveis são os seguintes:
- arquivos (pasta raiz)
- arquivos (atividade recente)
- arquivos (pesquisa avançada)
A implementação do método agora dá suporte (a partir de 5.1 em diante) nome de site multilíngue. O nome do< site da API versão 6 ou superior >representará no corpo da solicitação com base na ordem de preferência 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á nomes de site em todos os idiomas (que serão marcas adicionais em "API do próprio objeto" a partir de 5.1) versão 6 ou superior, no corpo da solicitação, eles estão enviando ambas as marcas <, ou seja, sitename> e <sitenametranslations> , em seguida, precisamos validar valores, por exemplo, <o nome do> site deve corresponder com a respectiva <marca de tradução> em termos de preferência de idioma do usuário. A API 7 ou superior, o site criado a partir do modelo seguirá 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 dá suporte à criação de site do modelo fornecendo a marca "sitetemplateid" (abordagem antiga)

Observe que o suporte para a criação de site a partir do modelo usando essa API será preterido no futuro. Para criar um site a partir do modelo, use o novo site de criação de API a partir do modelo (/sites/modelos/{templateid}/site), que é uma API de sondagem longa (com suporte para solicitações de execução prolongada)

Esse método dá suporte a vários números de matéria a serem adicionados ao site usando a API versão 10 em diante. A marca "matternos" indica vários números de matéria com leitura ou não. A versão mais antiga (menor que a versão 10) do número de matéria única "matterno" refletirá o primeiro número de matérias existentes no site.

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

Até a versão 17: o proprietário do site é o usuário conectado; nenhum outro usuário pode ser adicionado.

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

Da API versão 19 em diante, um novo módulo é introduzido chamado "customPages", que é fortemente acoplado ao módulo inicial. Portanto, se o valor do módulo inicial for True, customPages será true e vice-versa.

Adicionar usuário

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

Resumo	Código ref (antes da V4)	Código ref (V4)
O endereço de email é necessário	101	101
Endereço de email inválido	104	104
O nome é necessá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 email do secretário/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, Active Directory ou System default.	N/A	359
Insira o número de telefone válido	N/A	360
Insira o número de telefone válido no formato {countrycode} ${areacode}${number}.	N/A	361
Insira o número de celular válido no formato {countrycode}${number}.	N/A	362
Insira um código de país de telefone do office válido	N/A	363
O código do país do telefone do office pode ter no máximo 4 dígitos	N/A	364
Insira um código de área de telefone do office válido	N/A	365
O código da área de telefone do office pode ter no máximo 5 dígitos	N/A	366
O número de telefone do Office deve ter no máximo 15 dígitos	N/A	368
Inserir um código de país de telefone celular válido	N/A	369
O código do país do telefone celular pode ter no máximo 4 dígitos	N/A	372
Insira um número de celular válido	N/A	373
O número de telefone celular 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-registrado	187	187
Mencionar organização em caso de domínio excepcional	115	115
A ID da organização não está no formato adequado	112	112
A organização não existe	106	106
O domínio existe em outra organização	114	114
A ID de Endereço Inserida não é válida	N/A	308
Nome do link social não encontrado no sistema.	N/A	375
O nome do link social é necessário	N/A	376
O valor do link social é necessário	N/A	377
Os caracteres máximos para o valor de vínculo social devem 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 de 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 da mensagem deve estar entre 1 e 500	N/A	386
O link social está desabilitado	N/A	408
O link da mensagem está desabilitado	N/A	409
O link personalizado está desabilitado	N/A	410

Tíquete JIRA: https://dev.highq.com/jira/browse/COL-65685

Arquivar usuário

Essa chamada à API é usada para arquivar um usuário dentro do sistema.

Códigos de erro

Resumo	Código ref (antes da V4)	Código ref (V4)
Os usuários a seguir não existem dentro do sistema	110	110
Uma ID de Usuário é necessária	109	109
A ID do usuário não está no formato adequado	113	113
O comprimento da ID do usuário não pode exceder 50 caracteres	N/A	304

Tíquete 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ásico existente em um site.

Atualizar site

Use esse ponto de extremidade de API para atualizar os detalhes de um site existente. A API dá suporte aos mesmos campos usados na API criar site.

Esse método dá suporte a vários números de matéria a serem adicionados ao site usando a API versão 10 em diante. A marca "matternos" indica vários números de matéria com leitura ou não.

Versão 18 em diante: uma categoria (finalidade do site) é necessária. Se a finalidade do site estiver oculta, uma mensagem será exibida; caso contrário, as finalidades ocultas do site não sã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 maior que o administrador do site.

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

Da API versão 19 em diante, um novo módulo chamado customPages é introduzido, que é fortemente acoplado ao módulo inicial. Se o valor do módulo inicial for True, customPages deverá ser true e vice-versa.

Observe que todas as propriedades/elementos na resposta do site não são atualizáveis/inseriveis. Confira a tabela abaixo para saber quais são somente leitura, atualizáveis ou inseriveis.

Criar pasta

Essa API cria uma nova pasta no site especificado. Ele permite que você forneça detalhes da pasta e garante que a pasta seja criada na pasta pai fornecida.

Fazer upload de um arquivo

Essa chamada de API carrega um arquivo em uma pasta especificada na plataforma HighQ Collaborate. Ele dá suporte a uploads em partes quando o cabeçalho Content-Range é fornecido.

Mover documentos

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

Obter informações da pasta

O método fornece detalhes da pasta da ID da pasta fornecida.

Para criar o item iSheet

Essa chamada à API é usada para inserir o item iSheet. Há suporte para várias iSheets.

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

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

Nome	Tipo	Description
progressive_key	String	Chave para verificar o status da 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<registro de mensagem>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<registro de mensagem>adicionado com êxito</mensagem>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Recuperar colunas iSheet

Essa chamada à API recupera as colunas associadas ao iSheet especificado. Essa funcionalidade tem suporte na API versão 3 e superior.

Recuperar informações do arquivo

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

Recuperar lista de usuários

Recuperar uma lista de usuários essa API recupera uma lista de usuários do sistema. ## Principais Recursos – Buscar detalhes do usuário com várias opções de filtragem – dá suporte à paginação com `limit` e `offset` - Novos parâmetros de consulta e campos introduzidos em versões recentes - Resposta estruturada com funções de usuário e atributos ## Novos Parâmetros de Consulta (Version-Specific) – Introduzidos na V12: – `systemAdminSearch`Quando definido `1`como , retorna apenas usuários com a função de Administrador do Sistema. - Introduzido na V18: – `userid`Aceita valores separados por vírgulas (CSV). ## Atualizações do Corpo da Resposta - Novos campos adicionados: - `emaildomain`, , `org`, `invitationsent`, `createdbycreateddate`, `modifiedby`,`modifieddate` - `ifpartner` , `lastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, `publicprofile`, `dateOfBirth` # # Alteração de formato de endereço (de V11) - A `location` marca foi renomeada `address` para consistência. - Resposta de exemplo: `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 (introduzidas na API V11+) – Resposta de exemplo: `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 &Deslocamentos – Comportamento de Limite: – Padrão: `100` se nenhum valor for fornecido. - Use `-1` para retornar todos os registros. - Se o valor for menor que `-1`, o padrão será `100`. - Comportamento de deslocamento: – Padrão: `0` se nenhum valor for fornecido. - Se o deslocamento exceder o total de registros, o padrão volta 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 da V4) | Código Ref (V4) | |---------|----------------------|--------------| | Entrada inválida para status do usuário (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | A ID da organização é inválida | 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` (com suporte: nome, organização, status etc.) | N/A | 289 | | Inválido `orderby` (com suporte: asc, desc) | N/A | 290 | | Valor inválido `offset` | 138 | 138 | | Valor inválido `limit` | 137 | 137 | ## Anotações – da V13 em diante, essa API está aberta para todos os usuários (anteriormente limitada aos Administradores do Sistema). - Da V18 em diante, o `userregistered2FA` campo indica se um usuário se registrou para 2FA. --- Esta descrição segue a formatação de esquema do Swagger 2.0 e deve ser colocada no campo de descrição no esquema conector personalizado.

Recuperar uma lista de itens do iSheet

Essa chamada à API recupera uma lista de itens contidos na iSheet especificada.

Recuperar uma lista de pastas

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

Adicionar grupo existente ao site

ID da operação:: addExistingGroupToSite

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	versão
A ID do site	siteid	True	string	A ID do site.
A ID do grupo do sistema	groupid	True	string	A ID do grupo do sistema a ser adicionado ao site.

Retornos

Corpo: sitegroup

Adicionar site

ID da operação:: createSite

Parâmetros

Nome	Chave	Obrigató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.
sitename	sitename		string	O nome do site.
função	role		string	A função do site.
sitedescription	sitedescription		string	A descrição do site.
enabledmodules	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 da pasta do site.
ativar	enable		string	Habilitar o status do HomeDBO.
ativar	enable		string	Habilitar o status do ActivityDBO.
microblog	microblog		string	Conteúdo do microblog associado a ActivityDBO.
docid	docid		string	ID do documento.
blogTitle	blogTitle		string	Título da postagem no blog.
blogContent	blogContent		string	Conteúdo da postagem no blog.
showComment	showComment		integer	mostrar o comentário.
tagList	tagList		array of string	Lista de marcas associadas ao blog.
status	status		integer	status da postagem no blog.
siteID	siteID		integer	Identificador do site associado.
autor	author		string	Autor do blog.
categoryList	categoryList		array of string	Categorias atribuídas à postagem no blog.
notificationTypeID	notificationTypeID		integer	Identificador do tipo de notificação.
mensagem	message		string	Conteúdo da mensagem relacionado ao blog.
messageCode	messageCode		integer	Código associado à mensagem.
ID externo	externalID		string	Identificador externo vinculado ao blog.
data de publicação	publishDate		string	Data da publicação do blog.
processtype	processtype		string	Tipo de processo associado ao blog.
ativar	enable		string	Habilitar o status do BlogDBO.
wikiid	wikiid		integer	Identificador exclusivo para o wiki.
currentversionid	currentversionid		integer	Identificador para a versão atual do wiki
parentwikiid	parentwikiid		integer	Identificador para o wiki pai.
wikititle	wikititle		string	Título do wiki.
wikicontent	wikicontent		string	Conteúdo do wiki.
showcomment	showcomment		integer	Indicando se os comentários estão habilitados.
createddate	createddate		string	Data de criação do wiki.
modifieddate	modifieddate		string	Data da última modificação do wiki.
taglist	taglist		string	Lista separada por vírgulas de marcas associadas ao wiki.
wikipath	wikipath		string	Caminho para acessar o wiki.
wikidraftid	wikidraftid		integer	Identificador para a versão de rascunho do wiki.
tipo de rascunho	drafttype		string	Tipo de rascunho associado ao wiki.
status	status		integer	Status atual do wiki.
wikiversionid	wikiversionid		integer	Identificador de versão do wiki.
indexar	index		string	Indexar ou identificador para a tarefa.
parenttaskid	parenttaskid		integer	Identificador para a tarefa pai.
taskid	taskid		integer	Identificador exclusivo para a 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.
startdate	startdate		string	Data de início quando a tarefa foi iniciada.
mattermaptaskid	mattermaptaskid		string	Identificador vinculando-se à tarefa de mapa de matéria.
tipo	type		string	Tipo ou categoria da tarefa.
dependenton	dependenton		string	Tarefas das quais essa tarefa depende.
daysfromdependent	daysfromdependent		string	Número de dias da tarefa dependente.
ignoreweekend	ignoreweekend		integer	Indica se os fins de semana são ignorados no agendamento.
duration	duration		integer	Duração para concluir a tarefa.
recurso	resource		string	Recursos atribuídos à tarefa.
eventTitle	eventTitle		string	Título do evento.
eventContent	eventContent		string	Conteúdo do evento.
showComment	showComment		integer	Indicando se os comentários estão habilitados para o evento.
tagList	tagList		array of string	Lista de marcas associadas ao evento.
status	status		integer	Status atual do evento.
siteID	siteID		integer	Identificador do site.
contato	contact		string	Informações de contato para o evento.
categoryList	categoryList		array of string	Categorias nas quais o evento está listado.
notificationTypeID	notificationTypeID		integer	O tipo de notificação relacionado ao evento.
mensagem	message		string	A mensagem do evento.
messageCode	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 de término do evento.
startTime	startTime		string	A hora de início do evento.
endTime	endTime		string	A hora de término do evento.
local	location		string	O local do evento.
autor	author		string	O autor do evento.
processtype	processtype		string	A hora do processo do evento.
ativar	enable		string	Habilitar é o evento.
id	id		integer	Identificador exclusivo para o iSheet.
title	title		string	Título da iSheet.
descrição	description		string	Descrição da planilha.
status	status		string	Status da isheet.
accesstype	accesstype		string	Tipo de acesso da isheet.
tipo	type		string	Tipo da planilha.
viewlink	viewlink		string	Link para exibir a iSheet.
allowsections	allowsections		string	Se as seções são permitidas.
allowlookup	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 é a exibição padrão.
enableversion	enableversion		string	Sinalizador habilitado para controle de versão.
enablesheetalerter	enablesheetalerter		string	Sinalizador para habilitar alertas de planilha.
alertercondition	alertercondition		string	Condições para disparar alertas.
overrideitemmodifieddate	overrideitemmodifieddate		string	Substitua o sinalizador de data modificado.
enablebulkinsertupdate	enablebulkinsertupdate		string	Habilitar inserção/atualização em massa.
fielddescriptions	fielddescriptions		string	Descrições de campo para o iSheet.
enablerowlocking	enablerowlocking		string	Habilite o bloqueio em nível de linha.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Truncar o sinalizador de texto de várias linhas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Limite de caracteres para truncamento multilinha.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permitir a reutilização dos valores de lista de escolha.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permitir a reutilização de valores de lista de pontuação.
allowIsheetComments	allowIsheetComments		string	Permitir comentários no iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limite de registros permitidos para compartilhar.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Limite de compartilhamento de registros habilitado.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Habilite o compartilhamento de formulários para adicionar registros.
contagem de registros	recordcount		string	Contagem de registros atual.
sheettypeid	sheettypeid		integer	ID do tipo do iSheet
ativar	enable		string	Habilitar a funcionalidade de QA.
userid	userid		integer	ID de usuário.
email	email		string	endereço eletrônico.
httpavatar	httpavatar		string	URL HTTP do avatar.
Avatar	avatar		string	Imagem do avatar.
userlink	userlink		string	Link para o perfil do usuário.
httplink	httplink		string	Link HTTP para o perfil do usuário.
phone	phone		string	Número de telefone.
móvel	mobile		string	Número do celular.
departamento	department		string	Departamento do usuário.
ativar	enable		string	Habilitar a integração do Contract Express.
adminnote	adminnote		string	Notas administrativas relacionadas ao site.
startdate	startdate		string	A data de início da operação do site.
enddate	enddate		string	A data de término da operação do site.
createddate	createddate		string	A data em que o site foi criado.
archiveddate	archiveddate		string	A data em que o site foi arquivado.
clientno	clientno		string	O número do cliente associado ao site.
matterno	matterno		string	O número de matéria associado ao site.
página de aterrissagem	landingpage		string	A URL da página de aterrissagem do site.
link	link		string	Um link relacionado ao site.
status	status		string	O status atual do site.
statusid	statusid		integer	O identificador para o status do site.
size	size		string	O tamanho do site.
notas de cobrança	billingnotes		string	Anotações relacionadas à cobrança do site.
billingnextinvoicedate	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.
sitehttplink	sitehttplink		string	O link HTTP para o site.
isSyncable	isSyncable		integer	Indica se o site é sincronizado.
enforceusergroups	enforceusergroups		string	Os grupos de usuários imposto para o site.
csvSiteCategory	csvSiteCategory		string	A categoria do site no 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.
siteStatus	siteStatus		integer	O código de status do site.
applySiteTerms	applySiteTerms		integer	Indica se os termos do site são aplicados.
siteTerm	siteTerm		string	Os termos aplicados ao site.
termType	termType		integer	O tipo de termos aplicados ao site.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indica se os termos do site são necessários no próximo logon.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indica se os termos de site padrão estão habilitados.
advancedQAPermission	advancedQAPermission		integer	O nível de permissão de QA avançado para o site.
éInterno	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	Indicando se a administração do site é permitida.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Para habilitar a proteção de senha no nível do site.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Para habilitar a proteção de senha no nível do site.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Indica se a autenticação de senha usa um aplicativo de autenticação.
sitePassword	sitePassword		string	A senha associada ao site.
ipRestrictionEnable	ipRestrictionEnable		integer	Para habilitar restrições de IP para acesso ao site.
AVAILABLEIP	availableIP		string	Lista separada por vírgulas de endereços IP permitidos para acessar o site.
highqDrive	highqDrive		integer	Indica se a integração do HighQ Drive está habilitada.
applySiteHomePage	applySiteHomePage		integer	Para aplicar uma home page personalizada ao site.
siteHomePage	siteHomePage		string	URL da home page personalizada do site.
siteHomePageType	siteHomePageType		integer	Tipo da home page.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Para definir o próximo logon para a home page do site.
applyDisplayContent	applyDisplayContent		integer	Para aplicar as configurações de conteúdo de exibição.
displayContent	displayContent		string	Conteúdo a ser exibido no site.
rssSecurity	rssSecurity		integer	Nível de segurança do RSS Feed.
senhaCriptografada	encryptedPassword		integer	Indica se a senha do site está criptografada.
availableIPRangeCSV	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.
icalSecurity	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 habilitar alertas de email padrão.
excelReportFooter	excelReportFooter		integer	Inclui um rodapé em relatórios do Excel.
excelReportFooterText	excelReportFooterText		string	Texto a ser exibido no rodapé dos relatórios do Excel.
announcementMLJSON	announcementMLJSON		string	Anúncios formatados em JSON para o site.
templateType	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 planilha de metadados associada ao site.
mysite	mysite		boolean	Indica se esse é o site pessoal do usuário.
lastaccesseddate	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 o identificador de exibição.
folderMetadataViewId	folderMetadataViewId		integer	metadados de pasta para identificador de exibição.
docSort	docSort		integer	A ordem de classificação de documentos.
folderSort	folderSort		integer	A ordem de classificação de pastas.
defaultFolderRenderView	defaultFolderRenderView		integer	Determina o modo de exibição padrão para pastas.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	O local padrão para anexos de tarefa.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	O identificador exclusivo da pasta designada como o local padrão para anexos de tarefa.
favorito	favourite		string	status favorito.
enabledocumentredaction	enabledocumentredaction		boolean	Especifica se a redação do documento está habilitada para o site.
grupos de menções	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.

Retornos

Corpo: site

Adicionar usuário

ID da operação:: createUser

Resumo	Código ref (antes da V4)	Código ref (V4)
O endereço de email é necessário	101	101
Endereço de email inválido	104	104
O nome é necessá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 email do secretário/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, Active Directory ou System default.	N/A	359
Insira o número de telefone válido	N/A	360
Insira o número de telefone válido no formato {countrycode} ${areacode}${number}.	N/A	361
Insira o número de celular válido no formato {countrycode}${number}.	N/A	362
Insira um código de país de telefone do office válido	N/A	363
O código do país do telefone do office pode ter no máximo 4 dígitos	N/A	364
Insira um código de área de telefone do office válido	N/A	365
O código da área de telefone do office pode ter no máximo 5 dígitos	N/A	366
O número de telefone do Office deve ter no máximo 15 dígitos	N/A	368
Inserir um código de país de telefone celular válido	N/A	369
O código do país do telefone celular pode ter no máximo 4 dígitos	N/A	372
Insira um número de celular válido	N/A	373
O número de telefone celular 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-registrado	187	187
Mencionar organização em caso de domínio excepcional	115	115
A ID da organização não está no formato adequado	112	112
A organização não existe	106	106
O domínio existe em outra organização	114	114
A ID de Endereço Inserida não é válida	N/A	308
Nome do link social não encontrado no sistema.	N/A	375
O nome do link social é necessário	N/A	376
O valor do link social é necessário	N/A	377
Os caracteres máximos para o valor de vínculo social devem 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 de 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 da mensagem deve estar entre 1 e 500	N/A	386
O link social está desabilitado	N/A	408
O link da mensagem está desabilitado	N/A	409
O link personalizado está desabilitado	N/A	410

Tíquete JIRA: https://dev.highq.com/jira/browse/COL-65685

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	versão da api
indexar	index		integer	Índice exclusivo para o usuário.
userid	userid		integer	Identificador exclusivo do usuário.
primeiro nome	firstname		string	Nome do usuário.
sobrenome	lastname		string	Sobrenome do usuário.
grupo de práticas	practicegroup		string	Grupo de práticas ao qual o usuário pertence.
langcode	langcode		string	Código de idioma do usuário.
localeID	localeID		string	ID de localidade do usuário.
publicprofile	publicprofile		string	Perfil público do usuário.
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.
email	email		string	Email endereço do utilizador.
phone	phone		string	Número de telefone do usuário.
móvel	mobile		string	Número de celular do usuário.
departamento	department		string	Departamento do usuário.
org	org		string	Organização à qual o usuário pertence.
addressline1	addressline1		string	Primeira linha do endereço.
addressline2	addressline2		string	Segunda linha do endereço.
addressline3	addressline3		string	Terceira linha do endereço.
city	city		string	Cidade do endereço.
estado	state		string	Estado do endereço.
country	country		string	País do endereço.
Cp	postcode		string	Código postal do endereço.
addressid	addressid		string	Identificador exclusivo para o endereço.
addressline1	addressline1		string	Primeira linha do endereço.
addressline2	addressline2		string	Segunda linha do endereço.
addressline3	addressline3		string	Terceira linha do endereço.
city	city		string	Cidade do endereço.
estado	state		string	Estado do endereço.
country	country		string	País do endereço.
Cp	postCode		string	Código postal do endereço.
conhecido como	knownas		string	Nome ou apelido alternativo para o endereço.
experiência	experience		array of string
id	id		string	Link ID
nome	name		string	Nome do link.
value	value		string	Valor do link.
id	id		string	Link ID
nome	name		string	Nome do link.
value	value		string	Valor do link.
id	id		string	Link ID
nome	name		string	Nome do link.
value	value		string	Valor do link.
img	img		string
reportsto	reportsto		string
metadataname	metadataname		array of string
metadatavalue	metadatavalue		array of string
agrupar	group		array of string
externalid	externalid		string	ID externa do usuário.
jobtitle	jobtitle		string	Cargo do usuário.
nome do secretário	secretaryname		string	Nome do secretário do usuário.
secretarymail	secretarymail		string	Email do secretário do usuário.
Especialidades	specialities		string	Especialidades do usuário.
title	title		string	Título do usuário.
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.
bio	bio		string	Biografia do usuário.
dateOfBirth	dateOfBirth		string	Data de nascimento do usuário.
link	link		string	Link associado ao usuário.
status	status		string	Status do usuário.
statuscode	statuscode		string	Código de status do usuário.
mensagem	message		string	Mensagem associada ao usuário.
sourcetype	sourcetype		string	Tipo de origem do usuário.
orgid	orgid		string	ID da organização.
ifpartner	ifpartner		string	Sinalizador de parceiro.
emaildomain	emaildomain		string	Domínio de email do usuário.
invitationsent	invitationsent		string	Sinalizador enviado por convite.
criado por	createdby		string	Usuário que criou o registro.
createddate	createddate		string	Data em que o registro foi criado.
modificado por	modifiedby		string	Usuário que modificou o registro.
modifieddate	modifieddate		string	Data em que o registro foi modificado.
lastlogindate	lastlogindate		string	Data do último logon.
invalidlogins	invalidlogins		string	Contagem de tentativas de logon inválidas.
publicwebsiteprofileid	publicwebsiteprofileid		string	ID do perfil do site público.
resetpassworddate	resetpassworddate		string	Data em que a senha foi redefinida.
Avatar	avatar		string	URL da imagem do avatar.
followingcount	followingcount		integer	Contagem de usuários sendo seguidos.
followercount	followercount		integer	Contagem de seguidores.
seguinte	following		boolean	Sinalizador a seguir.
função	role		string	Função do usuário.
isbasicuser	isbasicuser		string	Sinalizador de usuário básico.
encryptedUserId	encryptedUserId		string	ID de usuário criptografada.
autoregistro	selfregistered		integer	Sinalizador auto-registrado.
registeredWith2FA	registeredWith2FA		string	Sinalizador de registro de autenticação de dois fatores.
éInterno	isInternal		integer	Sinalizador de usuário interno.
orgName	orgName		string	Nome da organização.

Retornos

Corpo: IntegrationUserDBO

Arquivar usuário

ID da operação:: deleteUser

Essa chamada à API é usada para arquivar um usuário dentro do sistema.

Códigos de erro

Resumo	Código ref (antes da V4)	Código ref (V4)
Os usuários a seguir não existem dentro do sistema	110	110
Uma ID de Usuário é necessária	109	109
A ID do usuário não está no formato adequado	113	113
O comprimento da ID do usuário não pode exceder 50 caracteres	N/A	304

Tíquete JIRA: https://dev.highq.com/jira/browse/COL-67441

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	versão da api
Identificação de usuário	userid	True	string	identificação de usuário

Atualizar grupo de sites

ID da operação:: updateSiteGroup

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ásico existente em um site.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	versão
A ID do site	siteid	True	string	A 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
numberofusers	numberofusers		string
criadas	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
descrição	description		string
basicusergroup	basicusergroup		integer

Retornos

Corpo: sitegroup

Atualizar site

ID da operação:: updateSite

Use esse ponto de extremidade de API para atualizar os detalhes de um site existente. A API dá suporte aos mesmos campos usados na API criar site.

Esse método dá suporte a vários números de matéria a serem adicionados ao site usando a API versão 10 em diante. A marca "matternos" indica vários números de matéria com leitura ou não.

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 maior que o administrador do site.

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

Observe que todas as propriedades/elementos na resposta do site não são atualizáveis/inseriveis. Confira a tabela abaixo para saber quais são somente leitura, atualizáveis ou inseriveis.

Parâmetros

Nome	Chave	Obrigató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.
sitename	sitename		string	O nome do site.
função	role		string	A função do site.
sitedescription	sitedescription		string	A descrição do site.
enabledmodules	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 da pasta do site.
ativar	enable		string	Habilitar o status do HomeDBO.
ativar	enable		string	Habilitar o status do ActivityDBO.
microblog	microblog		string	Conteúdo do microblog associado a ActivityDBO.
docid	docid		string	ID do documento.
blogTitle	blogTitle		string	Título da postagem no blog.
blogContent	blogContent		string	Conteúdo da postagem no blog.
showComment	showComment		integer	mostrar o comentário.
tagList	tagList		array of string	Lista de marcas associadas ao blog.
status	status		integer	status da postagem no blog.
siteID	siteID		integer	Identificador do site associado.
autor	author		string	Autor do blog.
categoryList	categoryList		array of string	Categorias atribuídas à postagem no blog.
notificationTypeID	notificationTypeID		integer	Identificador do tipo de notificação.
mensagem	message		string	Conteúdo da mensagem relacionado ao blog.
messageCode	messageCode		integer	Código associado à mensagem.
ID externo	externalID		string	Identificador externo vinculado ao blog.
data de publicação	publishDate		string	Data da publicação do blog.
processtype	processtype		string	Tipo de processo associado ao blog.
ativar	enable		string	Habilitar o status do BlogDBO.
wikiid	wikiid		integer	Identificador exclusivo para o wiki.
currentversionid	currentversionid		integer	Identificador para a versão atual do wiki
parentwikiid	parentwikiid		integer	Identificador para o wiki pai.
wikititle	wikititle		string	Título do wiki.
wikicontent	wikicontent		string	Conteúdo do wiki.
showcomment	showcomment		integer	Indicando se os comentários estão habilitados.
createddate	createddate		string	Data de criação do wiki.
modifieddate	modifieddate		string	Data da última modificação do wiki.
taglist	taglist		string	Lista separada por vírgulas de marcas associadas ao wiki.
wikipath	wikipath		string	Caminho para acessar o wiki.
wikidraftid	wikidraftid		integer	Identificador para a versão de rascunho do wiki.
tipo de rascunho	drafttype		string	Tipo de rascunho associado ao wiki.
status	status		integer	Status atual do wiki.
wikiversionid	wikiversionid		integer	Identificador de versão do wiki.
indexar	index		string	Indexar ou identificador para a tarefa.
parenttaskid	parenttaskid		integer	Identificador para a tarefa pai.
taskid	taskid		integer	Identificador exclusivo para a 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.
startdate	startdate		string	Data de início quando a tarefa foi iniciada.
mattermaptaskid	mattermaptaskid		string	Identificador vinculando-se à tarefa de mapa de matéria.
tipo	type		string	Tipo ou categoria da tarefa.
dependenton	dependenton		string	Tarefas das quais essa tarefa depende.
daysfromdependent	daysfromdependent		string	Número de dias da tarefa dependente.
ignoreweekend	ignoreweekend		integer	Indica se os fins de semana são ignorados no agendamento.
duration	duration		integer	Duração para concluir a tarefa.
recurso	resource		string	Recursos atribuídos à tarefa.
eventTitle	eventTitle		string	Título do evento.
eventContent	eventContent		string	Conteúdo do evento.
showComment	showComment		integer	Indicando se os comentários estão habilitados para o evento.
tagList	tagList		array of string	Lista de marcas associadas ao evento.
status	status		integer	Status atual do evento.
siteID	siteID		integer	Identificador do site.
contato	contact		string	Informações de contato para o evento.
categoryList	categoryList		array of string	Categorias nas quais o evento está listado.
notificationTypeID	notificationTypeID		integer	O tipo de notificação relacionado ao evento.
mensagem	message		string	A mensagem do evento.
messageCode	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 de término do evento.
startTime	startTime		string	A hora de início do evento.
endTime	endTime		string	A hora de término do evento.
local	location		string	O local do evento.
autor	author		string	O autor do evento.
processtype	processtype		string	A hora do processo do evento.
ativar	enable		string	Habilitar é o evento.
id	id		integer	Identificador exclusivo para o iSheet.
title	title		string	Título da iSheet.
descrição	description		string	Descrição da planilha.
status	status		string	Status da isheet.
accesstype	accesstype		string	Tipo de acesso da isheet.
tipo	type		string	Tipo da planilha.
viewlink	viewlink		string	Link para exibir a iSheet.
allowsections	allowsections		string	Se as seções são permitidas.
allowlookup	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 é a exibição padrão.
enableversion	enableversion		string	Sinalizador habilitado para controle de versão.
enablesheetalerter	enablesheetalerter		string	Sinalizador para habilitar alertas de planilha.
alertercondition	alertercondition		string	Condições para disparar alertas.
overrideitemmodifieddate	overrideitemmodifieddate		string	Substitua o sinalizador de data modificado.
enablebulkinsertupdate	enablebulkinsertupdate		string	Habilitar inserção/atualização em massa.
fielddescriptions	fielddescriptions		string	Descrições de campo para o iSheet.
enablerowlocking	enablerowlocking		string	Habilite o bloqueio em nível de linha.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Truncar o sinalizador de texto de várias linhas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Limite de caracteres para truncamento multilinha.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permitir a reutilização dos valores de lista de escolha.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permitir a reutilização de valores de lista de pontuação.
allowIsheetComments	allowIsheetComments		string	Permitir comentários no iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Limite de registros permitidos para compartilhar.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Limite de compartilhamento de registros habilitado.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Habilite o compartilhamento de formulários para adicionar registros.
contagem de registros	recordcount		string	Contagem de registros atual.
sheettypeid	sheettypeid		integer	ID do tipo do iSheet
ativar	enable		string	Habilitar a funcionalidade de QA.
userid	userid		integer	ID de usuário.
email	email		string	endereço eletrônico.
httpavatar	httpavatar		string	URL HTTP do avatar.
Avatar	avatar		string	Imagem do avatar.
userlink	userlink		string	Link para o perfil do usuário.
httplink	httplink		string	Link HTTP para o perfil do usuário.
phone	phone		string	Número de telefone.
móvel	mobile		string	Número do celular.
departamento	department		string	Departamento do usuário.
ativar	enable		string	Habilitar a integração do Contract Express.
adminnote	adminnote		string	Notas administrativas relacionadas ao site.
startdate	startdate		string	A data de início da operação do site.
enddate	enddate		string	A data de término da operação do site.
createddate	createddate		string	A data em que o site foi criado.
archiveddate	archiveddate		string	A data em que o site foi arquivado.
clientno	clientno		string	O número do cliente associado ao site.
matterno	matterno		string	O número de matéria associado ao site.
página de aterrissagem	landingpage		string	A URL da página de aterrissagem do site.
link	link		string	Um link relacionado ao site.
status	status		string	O status atual do site.
statusid	statusid		integer	O identificador para o status do site.
size	size		string	O tamanho do site.
notas de cobrança	billingnotes		string	Anotações relacionadas à cobrança do site.
billingnextinvoicedate	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.
sitehttplink	sitehttplink		string	O link HTTP para o site.
isSyncable	isSyncable		integer	Indica se o site é sincronizado.
enforceusergroups	enforceusergroups		string	Os grupos de usuários imposto para o site.
csvSiteCategory	csvSiteCategory		string	A categoria do site no 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.
siteStatus	siteStatus		integer	O código de status do site.
applySiteTerms	applySiteTerms		integer	Indica se os termos do site são aplicados.
siteTerm	siteTerm		string	Os termos aplicados ao site.
termType	termType		integer	O tipo de termos aplicados ao site.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indica se os termos do site são necessários no próximo logon.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indica se os termos de site padrão estão habilitados.
advancedQAPermission	advancedQAPermission		integer	O nível de permissão de QA avançado para o site.
éInterno	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	Indicando se a administração do site é permitida.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Para habilitar a proteção de senha no nível do site.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Para habilitar a proteção de senha no nível do site.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Indica se a autenticação de senha usa um aplicativo de autenticação.
sitePassword	sitePassword		string	A senha associada ao site.
ipRestrictionEnable	ipRestrictionEnable		integer	Para habilitar restrições de IP para acesso ao site.
AVAILABLEIP	availableIP		string	Lista separada por vírgulas de endereços IP permitidos para acessar o site.
highqDrive	highqDrive		integer	Indica se a integração do HighQ Drive está habilitada.
applySiteHomePage	applySiteHomePage		integer	Para aplicar uma home page personalizada ao site.
siteHomePage	siteHomePage		string	URL da home page personalizada do site.
siteHomePageType	siteHomePageType		integer	Tipo da home page.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Para definir o próximo logon para a home page do site.
applyDisplayContent	applyDisplayContent		integer	Para aplicar as configurações de conteúdo de exibição.
displayContent	displayContent		string	Conteúdo a ser exibido no site.
rssSecurity	rssSecurity		integer	Nível de segurança do RSS Feed.
senhaCriptografada	encryptedPassword		integer	Indica se a senha do site está criptografada.
availableIPRangeCSV	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.
icalSecurity	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 habilitar alertas de email padrão.
excelReportFooter	excelReportFooter		integer	Inclui um rodapé em relatórios do Excel.
excelReportFooterText	excelReportFooterText		string	Texto a ser exibido no rodapé dos relatórios do Excel.
announcementMLJSON	announcementMLJSON		string	Anúncios formatados em JSON para o site.
templateType	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 planilha de metadados associada ao site.
mysite	mysite		boolean	Indica se esse é o site pessoal do usuário.
lastaccesseddate	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 o identificador de exibição.
folderMetadataViewId	folderMetadataViewId		integer	metadados de pasta para identificador de exibição.
docSort	docSort		integer	A ordem de classificação de documentos.
folderSort	folderSort		integer	A ordem de classificação de pastas.
defaultFolderRenderView	defaultFolderRenderView		integer	Determina o modo de exibição padrão para pastas.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	O local padrão para anexos de tarefa.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	O identificador exclusivo da pasta designada como o local padrão para anexos de tarefa.
favorito	favourite		string	status favorito.
enabledocumentredaction	enabledocumentredaction		boolean	Especifica se a redação do documento está habilitada para o site.
grupos de menções	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.

Criar pasta

ID da operação:: addFolder

Essa API cria uma nova pasta no site especificado. Ele permite que você forneça detalhes da pasta e garante que a pasta seja criada na pasta pai fornecida.

Parâmetros

Nome	Chave	Obrigató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 pai	parentfolderid	True	string	O identificador exclusivo da pasta pai em que 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.
accessInherited	accessInherited		integer	Indica se o acesso à pasta é herdado.
batchID	batchID		string	O identificador de lote da operação.
dmsfolderid	dmsfolderid		string	O identificador da pasta DMS.
dmsParentFolderID	dmsParentFolderID		string	O identificador da pasta pai do DMS.
dmscreateddate	dmscreateddate		date-time	A data em que a pasta DMS foi criada.
dmsmodifiedBy	dmsmodifiedBy		string	O usuário que modificou a pasta DMS pela última vez.
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 email associados à pasta.

Retornos

Corpo: FolderDBOV1

Fazer upload de um arquivo

ID da operação:: insertDocument

Essa chamada de API carrega um arquivo em uma pasta especificada na plataforma HighQ Collaborate. Ele dá suporte a uploads em partes quando o cabeçalho Content-Range é fornecido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	Especifica a versão da API que está sendo usada.
Arquivo a ser carregado	file	True	file	Especifica o arquivo a ser carregado.
ID da pasta pai	parentfolderid	True	string	Especifica a ID exclusiva da pasta pai em que o arquivo será carregado.
Substituir sinalizador duplicado	overrideduplicate		boolean	Indica se os uploads de arquivo duplicados devem ser substituídos.
Nome do documento	filename	True	string	Especifica o nome do documento.
Observação de versão	versionnote		string	Fornece uma nota que descreve a versão do arquivo.
Chave de operação progressiva	progressiveoperkey		string	Especifica a chave usada para operações progressivas durante o upload 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 pai do DMS	dmsparentfolderid		string	Especifica a ID exclusiva da pasta pai no Sistema de Gerenciamento de Documentos.
ID do documento do DMS	dmsdocid		string	Especifica a ID exclusiva do documento no Sistema de Gerenciamento de Documentos.
Versão do documento do DMS	dmsversion		string	Especifica a versão do documento registrada no Sistema de Gerenciamento de Documentos.
Detalhes da notificação	notification		string	Fornece detalhes sobre as notificações a serem enviadas no upload de 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.

Mover documentos

ID da operação:: moveDocuments

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

Parâmetros

Nome	Chave	Obrigató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 movidas.

Obter informações da pasta

ID da operação:: getFolderInfo

O método fornece detalhes da pasta da ID da pasta fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	versão da api
ID da pasta	folderid	True	string	folderID
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 Status Compartilhado, Status Favorito para usuário conectado

Retornos

Corpo: FolderDBOV2

Para criar o item iSheet

ID da operação:: insertISheetItems

Essa chamada à API é usada para inserir o item iSheet. Há suporte para várias iSheets.

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

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

Nome	Tipo	Description
progressive_key	String	Chave para verificar o status da 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<registro de mensagem>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<registro de mensagem>adicionado com êxito</mensagem>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	Versão da api
Identificador de iSheet	isheetid	True	integer	ID da iSheet
Identificador de Exibição de Planilha	sheetviewid		integer	ID do modo de exibição iSheet (opcional)
id	id		integer	Identificador de Isheet.
title	title		string	Título da planilha.
descrição	description		string	Descrição da planilha.
status	status		string	Status da planilha.
accesstype	accesstype		string	Tipo de acesso da planilha.
tipo	type		string	Tipo da planilha.
viewlink	viewlink		string	Link de URL para exibir a planilha.
allowsections	allowsections		string	Indica se as seções são permitidas.
allowlookup	allowlookup		string	Indica se a pesquisa é permitida.
displayisheet	displayisheet		string	Exibir isheet.
searchasdefaultview	searchasdefaultview		string	Define a pesquisa como modo de exibição padrão.
enableversion	enableversion		string	Habilitar Versão.
enablesheetalerter	enablesheetalerter		string	Ativa o alerta de planilha.
alertercondition	alertercondition		string	Condição para disparar alertas.
overrideitemmodifieddate	overrideitemmodifieddate		string	Sobre o passeio é a data modificada do item.
enablebulkinsertupdate	enablebulkinsertupdate		string	Permitir atualização de inserção em massa.
fielddescriptions	fielddescriptions		string	descrição dos campos.
enablerowlocking	enablerowlocking		string	Habilita o bloqueio de linha.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Habilita o truncamento de limite de caracteres para texto multilinha.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	define o limite de caracteres para truncamento.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permite a reutilização dos valores de lista de escolha.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permite a reutilização dos valores da lista de pontuação.
allowIsheetComments	allowIsheetComments		string	Permite comentários na planilha.
shareRecordsLimit	shareRecordsLimit		integer	Limite em registros compartilhados.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Habilitar o limite de registro de compartilhamento.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Habilita o compartilhamento do formulário de adição de registro.
allowViewBaseRendering	allowViewBaseRendering		string	Permite a renderização base de exibições.
coluna	column		object
contagem de registros	recordcount		string	Número total de registros.
viewId	viewId		integer	Identificador exclusivo para o modo de exibição.
siteId	siteId		integer	Identificador do site associado.
nome do site	siteName		string	Nome do site.
sheetName	sheetName		string	Nome da planilha.
viewName	viewName		string	Nome da vista.
sheetId	sheetId		integer	Identificador da planilha.
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 para o 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 de sequência do item.
itemid	itemid		string	Identificador exclusivo para o item.
externalid	externalid		string	Identificador externo associado ao item.
columnid	columnid		integer	Identificador exclusivo para a 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 seção em que a coluna está localizada.
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 da condição da coluna.
rowid	rowid		integer	Identificador da linha.
columnid	columnid		integer	Identificador da coluna.
operatorid	operatorid		integer	Identificador do operador.
oprand	oprand		string	Valor de operando para o filtro.
logicaltype	logicaltype		string	Tipo lógico do filtro.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	ID do tipo de valor de filtro de planilha.
displaytype	displaytype		string	Tipo de exibição do filtro.
sourceColumnId	sourceColumnId		integer	ID da coluna de origem para o filtro.
scoreConditionTypeid	scoreConditionTypeid		integer	ID do tipo de condição de pontuação.
valor padrão	defaultvalue		string	Valor padrão para a coluna.
columnwidth	columnwidth		string	Largura da coluna.
sheetname	sheetname		string	Nome da planilha associada.
sitename	sitename		string	Nome do site.
obrigatório	mandatory		string	Indica se a coluna é obrigatória.
allowsearch	allowsearch		string	Especifica se a pesquisa é permitida.
maxchars	maxchars		integer	Número máximo de caracteres.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Permite o campo de outra planilha.
allowrichhtmltext	allowrichhtmltext		string	Especifica se o texto HTML avançado é permitido.
numberoflines	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 exclusivo para a escolha."
etiqueta	label		string	Rótulo para a escolha.
pontuação	score		string	Pontuação associada à escolha.
color	color		string	Código de cor para a escolha.
imageid	imageid		integer	ID da imagem associada.
includeinalertpreferences	includeinalertpreferences		string	Inclui em preferências de alerta.
min	min		string	Valor mínimo para a coluna.
max	max		string	Valor máximo para a coluna.
decimalplaces	decimalplaces		integer	Número de casas decimais.
showthousandseparators	showthousandseparators		string	Exibe mil separadores.
showaspercentage	showaspercentage		string	Exibe o valor como porcentagem.
formattype	formattype		string	Especifica o tipo de formato da coluna.
dateformat	dateformat		string	Define o formato de data da 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 planilha.
fielddisplay	fielddisplay		string	Determina como o campo é exibido.
allowmultipleusers	allowmultipleusers		string	Especifica se vários usuários podem acessar o campo.
methodtype	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 as IDs das colunas.
viewid	viewid		integer	Especifica a ID do modo de exibição.
allowmultiplevalues	allowmultiplevalues		string	Indica se vários valores são permitidos na coluna.
restrictdelete	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.
linkname	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 planilha atual.
targetsheetcolumnid	targetsheetcolumnid		integer	ID da coluna da planilha 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 de coluna.
minlength	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.
otherscorevalue	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.
analysisengine	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 anexo está no site atual.
singleLineEmailValidation	singleLineEmailValidation		string	Especifica se a validação de email de linha única é aplicada.
somente 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 de sequência da coluna.
attributecolumnid	attributecolumnid		string	Identificador de coluna de atributo.
value	value		string	Valor de dados brutos.
date	date		string	data dos dados brutos.
time	time		string	Tempo de dados brutos.
linkdisplayname	linkdisplayname		string	Nome do link de exibição.
linkdisplayurl	linkdisplayurl		string	Exibir link de URL.
id	id		string	ID de pesquisa
email	email		string	Endereço de email.
userlookuptype	userlookuptype		string	Tipo de pesquisa de usuário.
folderid	folderid		string	ID da pasta.
docid	docid		string	ID do documento.
fromdate	fromdate		string	A partir da data.
todate	todate		string	Até o momento.
arquivo	file		string	O conteúdo do arquivo.
nome	name		string	O nome do anexo.
ordem	order		string	A ordem do anexo.
id	id		integer	Identificador exclusivo para o anexo.
extensão	extension		string	Extensão.
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.
folderhttplink	folderhttplink		string	Link HTTP para a pasta.
filesize	filesize		integer	Tamanho do arquivo em bytes.
redactionStatus	redactionStatus		boolean	Indica se o arquivo foi redigido.
displayname	displayname		string	Nome de exibição do anexo.
siteid	siteid		integer	ID do site associado ao anexo.
Recordid	recordid		string	ID do registro.
linkname	linkname		string	Nome do link.
apilink	apilink		string	Link da API.
httplink	httplink		string	Link HTTP.
colViewPosition	colViewPosition		integer	Posição da coluna no modo de exibição.
columntype	columntype		string	Tipo da coluna.
createdDate	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 reutilizado de uma folha de entrada.
choicelistid	choicelistid		integer	Identificador para a lista de opções associada à coluna.
alerteroption	alerteroption		string	Configuração da opção de alerta para o item.
sheettypeid	sheettypeid		integer	Identificador para o tipo de planilha.
enableSmartForm	enableSmartForm		string	Ativa recursos de formulário inteligente.
allowDeletedItemsView	allowDeletedItemsView		string	Permite a exibição de itens excluídos.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Permite todas as colunas em exibições personalizadas.

Retornos

Corpo: ProgressiveKeyDBO

Recuperar colunas iSheet

ID da operação:: getIsheetColumns

Essa chamada à API recupera as colunas associadas ao iSheet especificado. Essa funcionalidade tem suporte na API versão 3 e superior.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do iSheet	isheetid	True	integer	Especifica a ID exclusiva da iSheet para a 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 modo de exibição iSheet	sheetviewid		string	Especifica a ID do modo de exibição iSheet. Se omitido, todas as colunas serão retornadas.
Incluir colunas iSheet excluídas	onlyForDeletedIsheet		boolean	Indica se as colunas devem ser incluídas de uma iSheet excluída. O valor padrão é false.

Retornos

Corpo: columns

Recuperar informações do arquivo

ID da operação:: getDocumentInfo

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

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	Especifica a versão da API que está sendo usada.
ID de Arquivo	fileid	True	string	Especifica a ID exclusiva do arquivo.
Sinalizador de informações mais recentes do DMS	lastdmsinfo		boolean	Indica se as informações mais recentes serão recuperadas do Sistema de Gerenciamento de Documentos.
Tipo de pasta	foldertype		string	Especifica o tipo de pasta, se aplicável.
Incluir informações de status do arquivo	statusinfo		boolean	Indica se deve incluir informações adicionais de status de arquivo, como status compartilhado, status favorito, contagem de tarefas e status de curtição. O valor padrão é false.
Incluir metadados de email	emailmetadata		boolean	Indica se os metadados de email devem ser incluídos, como remetente, destinatários e carimbos de data/hora. O valor padrão é false.

Retornos

Corpo: DocumentDBO

Recuperar lista de usuários

ID da operação:: getAllSystemUsers

Recuperar uma lista de usuários essa API recupera uma lista de usuários do sistema. ## Principais Recursos – Buscar detalhes do usuário com várias opções de filtragem – dá suporte à paginação com `limit` e `offset` - Novos parâmetros de consulta e campos introduzidos em versões recentes - Resposta estruturada com funções de usuário e atributos ## Novos Parâmetros de Consulta (Version-Specific) – Introduzidos na V12: – `systemAdminSearch`Quando definido `1`como , retorna apenas usuários com a função de Administrador do Sistema. - Introduzido na V18: – `userid`Aceita valores separados por vírgulas (CSV). ## Atualizações do Corpo da Resposta - Novos campos adicionados: - `emaildomain`, , `org`, `invitationsent`, `createdbycreateddate`, `modifiedby`,`modifieddate` - `ifpartner` , `lastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, `publicprofile`, `dateOfBirth` # # Alteração de formato de endereço (de V11) - A `location` marca foi renomeada `address` para consistência. - Resposta de exemplo: `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 (introduzidas na API V11+) – Resposta de exemplo: `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 &Deslocamentos – Comportamento de Limite: – Padrão: `100` se nenhum valor for fornecido. - Use `-1` para retornar todos os registros. - Se o valor for menor que `-1`, o padrão será `100`. - Comportamento de deslocamento: – Padrão: `0` se nenhum valor for fornecido. - Se o deslocamento exceder o total de registros, o padrão volta 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 da V4) | Código Ref (V4) | |---------|----------------------|--------------| | Entrada inválida para status do usuário (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | A ID da organização é inválida | 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` (com suporte: nome, organização, status etc.) | N/A | 289 | | Inválido `orderby` (com suporte: asc, desc) | N/A | 290 | | Valor inválido `offset` | 138 | 138 | | Valor inválido `limit` | 137 | 137 | ## Anotações – da V13 em diante, essa API está aberta para todos os usuários (anteriormente limitada aos Administradores do Sistema). - Da V18 em diante, o `userregistered2FA` campo indica se um usuário se registrou para 2FA. --- Esta descrição segue a formatação de esquema do Swagger 2.0 e deve ser colocada no campo de descrição no esquema conector personalizado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	version	True	string	Versão da API.
Status do Usuário	status		string	Filtrar 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 serem retornados por solicitação.
ID da Organização	orgid		string	Filtrar usuários por ID da organização.
Usuários Nunca Convidados	neverinvited		string	Recupere usuários que nunca foram convidados.
Usuários nunca conectados	neverlogin		string	Recupere usuários que nunca fizeram logon.
ID do Usuário	userid		string	Filtre os usuários por suas IDs de usuário exclusivas.
ID do grupo	groupid		string	Filtrar usuários por IDs 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 externa	externalid		string	Filtrar usuários por ID externa.
Primeiro Nome	firstname		string	Filtrar usuários pelo nome.
Apelido	lastname		string	Filtrar usuários por sobrenome.
Endereço de Email	email		string	Filtrar usuários por endereço de email.
Pesquisa de Usuário	search		string	Pesquise usuários por vários atributos, incluindo nome, email e cargo.
Filtro de alfabeto	alphabets		string	Filtrar usuários cujo sobrenome começa com uma letra específica.
Cargo	jobtitle		string	Filtrar usuários por cargo.
Localização	locations		string	Filtrar usuários por cidade.
Departamento	departments		string	Filtrar usuários por departamento.
Nome da Organização	organisations		string	Filtrar usuários pelo nome da organização.
Especialidades	specialities		string	Filtrar os usuários por suas especialidades.
Pesquisa de Administrador do Sistema	systemAdminSearch		string	Recuperar usuários com a função de Administrador do Sistema.

Retornos

Corpo: users

Recuperar uma lista de itens do iSheet

ID da operação:: getISheetItems

Essa chamada à API recupera uma lista de itens contidos na iSheet especificada.

Parâmetros

Nome	Chave	Obrigató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 a ID exclusiva do iSheet.
ID do modo de exibição iSheet	sheetviewid		integer	Especifica a ID do modo de exibição iSheet. Se omitido, o modo de exibição padrão será retornado.
Classificar ID da Coluna	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 registro	limit		integer	Especifica o número máximo de registros a serem retornados; o valor padrão será 100 se não for especificado.
Deslocamento de registro	offset		integer	Especifica a posição inicial para recuperação de registro; o padrão é 0 se não for especificado.
Incluir todas as colunas	allColumnRequired		boolean	Um sinalizador que indica se todos os dados de coluna devem ser incluídos, independentemente da 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 do item.

Retornos

Nome	Caminho	Tipo	Description
isheet	isheet	array of object	Uma lista de itens do iSheet.
ID do item	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 de exibição da coluna.
value	isheet.data.value	string	O valor contido na coluna.

Recuperar uma lista de pastas

ID da operação:: getFolderList

Parâmetros

Nome	Chave	Obrigató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 retornados.
Deslocamento de itens	offset		string	Especifica a posição inicial dos 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 de status da pasta devem ser incluídas. O valor padrão é false.
Incluir pastas inteligentes	includesmartfolder		boolean	Indica se as pastas inteligentes devem ser incluídas na lista retornada. O valor padrão é false.

Retornos

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

Definições

ErrorDBO

Nome	Caminho	Tipo
resumo	summary	string
ref	ref	string
link	link	string

DocumentDBO

Nome	Caminho	Tipo	Description
docid	docid	string	ID do documento.

columns

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

LocationDBO

Nome	Caminho	Tipo	Description
addressline1	addressline1	string	Primeira linha do endereço.
addressline2	addressline2	string	Segunda linha do endereço.
addressline3	addressline3	string	Terceira linha do endereço.
city	city	string	Cidade do endereço.
estado	state	string	Estado do endereço.
country	country	string	País do endereço.
Cp	postcode	string	Código postal do endereço.

UserName

Nome	Caminho	Tipo	Description
title	title	string	Título do usuário.
primeiro nome	firstname	string	Nome do usuário.
sobrenome	lastname	string	Sobrenome do usuário.
goesby	goesby	string	nome preferencial do usuário.

MetadataListDBO

Nome	Caminho	Tipo	Description
metadataname	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

Nome	Caminho	Tipo	Description
id	id	string	Link ID
nome	name	string	Nome do link.
value	value	string	Valor do link.

Link

Nome	Caminho	Tipo	Description
link	link	array of NameValueLink

ExperiencesDBO

Nome	Caminho	Tipo	Description
experiência	experience	array of string

GroupsDBO

Nome	Caminho	Tipo	Description
agrupar	group	array of string

usuário

Nome	Caminho	Tipo	Description
userid	userid	integer	ID de usuário.
seguinte	following	boolean	Seguinte.
email	email	string	Endereço eletrônico.
nome	name	UserName
userlink	userlink	string	Link do Usuário.
httplink	httplink	string	Link HTTP.
httpavatar	httpavatar	string	Avatar HTTP.
Avatar	avatar	integer	Avatar do usuário.
externalid	externalid	string	ID externa.
dateofbirth	dateofbirth	string	Data de nascimento.
phone	phone	string	Número de telefone.
jobtitle	jobtitle	string	Cargo.
móvel	mobile	string	Número do celular.
departamento	department	string	Deparmentação.
status	status	string	Status.
org	org	string	Organização.
orgName	orgName	string	Nome da organização.
local	location	LocationDBO
img	img	string	Imagem.
Experiências	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
customlink	customlink	Link
messaginglink	messaginglink	Link
nome do secretário	secretaryname	string	Nome do Secretário.
secretarymail	secretarymail	string	Secretário Mail.
bio	bio	string	Biografia do usuário.
sourcetype	sourcetype	string	Tipo de origem.
Especialidades	specialities	string	Especialidades.
reportsto	reportsto	string	Usuário ao 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.
link	link	string	Link associado ao usuário.
loggeduserlike	loggeduserlike	integer	Contagem de curtidas do usuário conectado.
userName	userName	string	Nome de Usuário.

users

Nome	Caminho	Tipo	Description
usuário	user	array of user

FolderDBOV1

Nome	Caminho	Tipo	Description
folderid	folderid	string	O identificador exclusivo da pasta criada.

DmsDBO

Nome	Caminho	Tipo	Description
dmsfolderid	dmsfolderid	string	O identificador da pasta DMS.
dmsParentFolderID	dmsParentFolderID	string	O identificador da pasta pai do DMS.
dmscreateddate	dmscreateddate	date-time	A data em que a pasta DMS foi criada.
dmsmodifiedBy	dmsmodifiedBy	string	O usuário que modificou a pasta DMS pela última vez.
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

Nome	Caminho	Tipo
nome	name	string
id	id	integer
copypermissionsfrom	copypermissionsfrom	string
mensagem	message	string
typeID	typeID	integer
tipo	type	string
numberofusers	numberofusers	string
criadas	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
descrição	description	string
basicusergroup	basicusergroup	integer

Endereço

Nome	Caminho	Tipo	Description
addressid	addressid	string	Identificador exclusivo para o endereço.
addressline1	addressline1	string	Primeira linha do endereço.
addressline2	addressline2	string	Segunda linha do endereço.
addressline3	addressline3	string	Terceira linha do endereço.
city	city	string	Cidade do endereço.
estado	state	string	Estado do endereço.
country	country	string	País do endereço.
Cp	postCode	string	Código postal do endereço.
conhecido como	knownas	string	Nome ou apelido alternativo para o endereço.

IntegrationUserDBO

Nome	Caminho	Tipo	Description
indexar	index	integer	Índice exclusivo para o usuário.
userid	userid	integer	Identificador exclusivo do usuário.
primeiro nome	firstname	string	Nome do usuário.
sobrenome	lastname	string	Sobrenome do usuário.
grupo de práticas	practicegroup	string	Grupo de práticas ao qual o usuário pertence.
langcode	langcode	string	Código de idioma do usuário.
localeID	localeID	string	ID de localidade do usuário.
publicprofile	publicprofile	string	Perfil público do usuário.
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.
email	email	string	Email endereço do utilizador.
phone	phone	string	Número de telefone do usuário.
móvel	mobile	string	Número de celular do usuário.
departamento	department	string	Departamento do usuário.
org	org	string	Organização à qual o usuário pertence.
local	location	LocationDBO
address	address	Address
Experiências	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
messaginglink	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadados	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	ID externa do usuário.
jobtitle	jobtitle	string	Cargo do usuário.
nome do secretário	secretaryname	string	Nome do secretário do usuário.
secretarymail	secretarymail	string	Email do secretário do usuário.
Especialidades	specialities	string	Especialidades do usuário.
title	title	string	Título do usuário.
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.
bio	bio	string	Biografia do usuário.
dateOfBirth	dateOfBirth	string	Data de nascimento do usuário.
link	link	string	Link associado ao usuário.
status	status	string	Status do usuário.
statuscode	statuscode	string	Código de status do usuário.
mensagem	message	string	Mensagem associada ao usuário.
sourcetype	sourcetype	string	Tipo de origem do usuário.
orgid	orgid	string	ID da organização.
ifpartner	ifpartner	string	Sinalizador de parceiro.
emaildomain	emaildomain	string	Domínio de email do usuário.
invitationsent	invitationsent	string	Sinalizador enviado por convite.
criado por	createdby	string	Usuário que criou o registro.
createddate	createddate	string	Data em que o registro foi criado.
modificado por	modifiedby	string	Usuário que modificou o registro.
modifieddate	modifieddate	string	Data em que o registro foi modificado.
lastlogindate	lastlogindate	string	Data do último logon.
invalidlogins	invalidlogins	string	Contagem de tentativas de logon inválidas.
publicwebsiteprofileid	publicwebsiteprofileid	string	ID do perfil do site público.
resetpassworddate	resetpassworddate	string	Data em que a senha foi redefinida.
Avatar	avatar	string	URL da imagem do avatar.
followingcount	followingcount	integer	Contagem de usuários sendo seguidos.
followercount	followercount	integer	Contagem de seguidores.
seguinte	following	boolean	Sinalizador a seguir.
função	role	string	Função do usuário.
isbasicuser	isbasicuser	string	Sinalizador de usuário básico.
encryptedUserId	encryptedUserId	string	ID de usuário criptografada.
autoregistro	selfregistered	integer	Sinalizador auto-registrado.
registeredWith2FA	registeredWith2FA	string	Sinalizador de registro de autenticação de dois fatores.
éInterno	isInternal	integer	Sinalizador de usuário interno.
orgName	orgName	string	Nome da organização.

site

Nome	Caminho	Tipo	Description
id	id	integer	O identificador do site.
sitename	sitename	string	O nome do site.
função	role	string	A função do site.
sitedescription	sitedescription	string	A descrição do site.
enabledmodules	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 da pasta do site.
módulo	module	ModuleDBO
adminnote	adminnote	string	Notas administrativas relacionadas ao site.
startdate	startdate	string	A data de início da operação do site.
enddate	enddate	string	A data de término da operação do site.
createddate	createddate	string	A data em que o site foi criado.
archiveddate	archiveddate	string	A data em que o site foi arquivado.
clientno	clientno	string	O número do cliente associado ao site.
matterno	matterno	string	O número de matéria associado ao site.
página de aterrissagem	landingpage	string	A URL da página de aterrissagem do site.
link	link	string	Um link relacionado ao site.
status	status	string	O status atual do site.
statusid	statusid	integer	O identificador para o status do site.
size	size	string	O tamanho do site.
notas de cobrança	billingnotes	string	Anotações relacionadas à cobrança do site.
billingnextinvoicedate	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.
sitehttplink	sitehttplink	string	O link HTTP para o site.
isSyncable	isSyncable	integer	Indica se o site é sincronizado.
enforceusergroups	enforceusergroups	string	Os grupos de usuários imposto para o site.
csvSiteCategory	csvSiteCategory	string	A categoria do site no 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.
siteStatus	siteStatus	integer	O código de status do site.
applySiteTerms	applySiteTerms	integer	Indica se os termos do site são aplicados.
siteTerm	siteTerm	string	Os termos aplicados ao site.
termType	termType	integer	O tipo de termos aplicados ao site.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Indica se os termos do site são necessários no próximo logon.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Indica se os termos de site padrão estão habilitados.
advancedQAPermission	advancedQAPermission	integer	O nível de permissão de QA avançado para o site.
éInterno	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	Indicando se a administração do site é permitida.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	Para habilitar a proteção de senha no nível do site.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	Para habilitar a proteção de senha no nível do site.
passcodeUsingAuthApp	passcodeUsingAuthApp	integer	Indica se a autenticação de senha usa um aplicativo de autenticação.
sitePassword	sitePassword	string	A senha associada ao site.
ipRestrictionEnable	ipRestrictionEnable	integer	Para habilitar restrições de IP para acesso ao site.
AVAILABLEIP	availableIP	string	Lista separada por vírgulas de endereços IP permitidos para acessar o site.
highqDrive	highqDrive	integer	Indica se a integração do HighQ Drive está habilitada.
applySiteHomePage	applySiteHomePage	integer	Para aplicar uma home page personalizada ao site.
siteHomePage	siteHomePage	string	URL da home page personalizada do site.
siteHomePageType	siteHomePageType	integer	Tipo da home page.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	Para definir o próximo logon para a home page do site.
applyDisplayContent	applyDisplayContent	integer	Para aplicar as configurações de conteúdo de exibição.
displayContent	displayContent	string	Conteúdo a ser exibido no site.
rssSecurity	rssSecurity	integer	Nível de segurança do RSS Feed.
senhaCriptografada	encryptedPassword	integer	Indica se a senha do site está criptografada.
availableIPRangeCSV	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.
icalSecurity	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 habilitar alertas de email padrão.
excelReportFooter	excelReportFooter	integer	Inclui um rodapé em relatórios do Excel.
excelReportFooterText	excelReportFooterText	string	Texto a ser exibido no rodapé dos relatórios do Excel.
announcementMLJSON	announcementMLJSON	string	Anúncios formatados em JSON para o site.
templateType	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 planilha de metadados associada ao site.
mysite	mysite	boolean	Indica se esse é o site pessoal do usuário.
lastaccesseddate	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 o identificador de exibição.
folderMetadataViewId	folderMetadataViewId	integer	metadados de pasta para identificador de exibição.
docSort	docSort	integer	A ordem de classificação de documentos.
folderSort	folderSort	integer	A ordem de classificação de pastas.
defaultFolderRenderView	defaultFolderRenderView	integer	Determina o modo de exibição padrão para pastas.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	O local padrão para anexos de tarefa.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	O identificador exclusivo da pasta designada como o local padrão para anexos de tarefa.
favorito	favourite	string	status favorito.
enabledocumentredaction	enabledocumentredaction	boolean	Especifica se a redação do documento está habilitada para o site.
grupos de menções	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

Nome	Caminho	Tipo
Casa	home	HomeDBO
atividade	activity	ActivityDBO
documento	document	DocumentDBO
blog	blog	BlogDBO
wiki	wiki	WikiDBO
tarefa	task	TaskDBO
evento	event	EventDBO
isheet	isheet	ISheetDBO
Qa	qa	QaDBO
people	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Nome	Caminho	Tipo	Description
ativar	enable	string	Habilitar o status do HomeDBO.

ActivityDBO

Nome	Caminho	Tipo	Description
ativar	enable	string	Habilitar o status do ActivityDBO.
microblog	microblog	string	Conteúdo do microblog associado a ActivityDBO.

BlogDBO

Nome	Caminho	Tipo	Description
blogTitle	blogTitle	string	Título da postagem no blog.
blogContent	blogContent	string	Conteúdo da postagem no blog.
showComment	showComment	integer	mostrar o comentário.
tagList	tagList	array of string	Lista de marcas associadas ao blog.
status	status	integer	status da postagem no blog.
siteID	siteID	integer	Identificador do site associado.
autor	author	string	Autor do blog.
categoryList	categoryList	array of string	Categorias atribuídas à postagem no blog.
notificationTypeID	notificationTypeID	integer	Identificador do tipo de notificação.
mensagem	message	string	Conteúdo da mensagem relacionado ao blog.
messageCode	messageCode	integer	Código associado à mensagem.
ID externo	externalID	string	Identificador externo vinculado ao blog.
data de publicação	publishDate	string	Data da publicação do blog.
processtype	processtype	string	Tipo de processo associado ao blog.
ativar	enable	string	Habilitar o status do BlogDBO.

WikiDBO

Nome	Caminho	Tipo	Description
wikiid	wikiid	integer	Identificador exclusivo para o wiki.
currentversionid	currentversionid	integer	Identificador para a versão atual do wiki
parentwikiid	parentwikiid	integer	Identificador para o wiki pai.
wikititle	wikititle	string	Título do wiki.
wikicontent	wikicontent	string	Conteúdo do wiki.
showcomment	showcomment	integer	Indicando se os comentários estão habilitados.
createddate	createddate	string	Data de criação do wiki.
modifieddate	modifieddate	string	Data da última modificação do wiki.
taglist	taglist	string	Lista separada por vírgulas de marcas associadas ao wiki.
wikipath	wikipath	string	Caminho para acessar o wiki.
wikidraftid	wikidraftid	integer	Identificador para a versão de rascunho do wiki.
tipo de rascunho	drafttype	string	Tipo de rascunho associado ao wiki.
status	status	integer	Status atual do wiki.
wikiversionid	wikiversionid	integer	Identificador de versão do wiki.

TaskDBO

Nome	Caminho	Tipo	Description
indexar	index	string	Indexar ou identificador para a tarefa.
parenttaskid	parenttaskid	integer	Identificador para a tarefa pai.
taskid	taskid	integer	Identificador exclusivo para a 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.
startdate	startdate	string	Data de início quando a tarefa foi iniciada.
mattermaptaskid	mattermaptaskid	string	Identificador vinculando-se à tarefa de mapa de matéria.
tipo	type	string	Tipo ou categoria da tarefa.
dependenton	dependenton	string	Tarefas das quais essa tarefa depende.
daysfromdependent	daysfromdependent	string	Número de dias da tarefa dependente.
ignoreweekend	ignoreweekend	integer	Indica se os fins de semana são ignorados no agendamento.
duration	duration	integer	Duração para concluir a tarefa.
recurso	resource	string	Recursos atribuídos à tarefa.

EventDBO

Nome	Caminho	Tipo	Description
eventTitle	eventTitle	string	Título do evento.
eventContent	eventContent	string	Conteúdo do evento.
showComment	showComment	integer	Indicando se os comentários estão habilitados para o evento.
tagList	tagList	array of string	Lista de marcas associadas ao evento.
status	status	integer	Status atual do evento.
siteID	siteID	integer	Identificador do site.
contato	contact	string	Informações de contato para o evento.
categoryList	categoryList	array of string	Categorias nas quais o evento está listado.
notificationTypeID	notificationTypeID	integer	O tipo de notificação relacionado ao evento.
mensagem	message	string	A mensagem do evento.
messageCode	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 de término do evento.
startTime	startTime	string	A hora de início do evento.
endTime	endTime	string	A hora de término do evento.
local	location	string	O local do evento.
autor	author	string	O autor do evento.
processtype	processtype	string	A hora do processo do evento.
ativar	enable	string	Habilitar é o evento.

ISheetDBO

Nome	Caminho	Tipo	Description
id	id	integer	Identificador exclusivo para o iSheet.
title	title	string	Título da iSheet.
descrição	description	string	Descrição da planilha.
status	status	string	Status da isheet.
accesstype	accesstype	string	Tipo de acesso da isheet.
tipo	type	string	Tipo da planilha.
viewlink	viewlink	string	Link para exibir a iSheet.
allowsections	allowsections	string	Se as seções são permitidas.
allowlookup	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 é a exibição padrão.
enableversion	enableversion	string	Sinalizador habilitado para controle de versão.
enablesheetalerter	enablesheetalerter	string	Sinalizador para habilitar alertas de planilha.
alertercondition	alertercondition	string	Condições para disparar alertas.
overrideitemmodifieddate	overrideitemmodifieddate	string	Substitua o sinalizador de data modificado.
enablebulkinsertupdate	enablebulkinsertupdate	string	Habilitar inserção/atualização em massa.
fielddescriptions	fielddescriptions	string	Descrições de campo para o iSheet.
enablerowlocking	enablerowlocking	string	Habilite o bloqueio em nível de linha.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Truncar o sinalizador de texto de várias linhas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Limite de caracteres para truncamento multilinha.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Permitir a reutilização dos valores de lista de escolha.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Permitir a reutilização de valores de lista de pontuação.
allowIsheetComments	allowIsheetComments	string	Permitir comentários no iSheet.
shareRecordsLimit	shareRecordsLimit	integer	Limite de registros permitidos para compartilhar.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Limite de compartilhamento de registros habilitado.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Habilite o compartilhamento de formulários para adicionar registros.
contagem de registros	recordcount	string	Contagem de registros atual.
sheettypeid	sheettypeid	integer	ID do tipo do iSheet

QaDBO

Nome	Caminho	Tipo	Description
ativar	enable	string	Habilitar a funcionalidade de QA.

PeopleDBO

Nome	Caminho	Tipo	Description
pessoa	person	array of PersonDBO

PersonDBO

Nome	Caminho	Tipo	Description
userid	userid	integer	ID de usuário.
email	email	string	endereço eletrônico.
httpavatar	httpavatar	string	URL HTTP do avatar.
Avatar	avatar	string	Imagem do avatar.
userlink	userlink	string	Link para o perfil do usuário.
httplink	httplink	string	Link HTTP para o perfil do usuário.
phone	phone	string	Número de telefone.
móvel	mobile	string	Número do celular.
departamento	department	string	Departamento do usuário.

ContractExpressDBO

Nome	Caminho	Tipo	Description
ativar	enable	string	Habilitar a integração do Contract Express.

FolderDBOV2

Nome	Caminho	Tipo	Description
nome	name	string	Nome da pasta.
descrição	description	string	Descrição da pasta.
parentFolderID	parentFolderID	integer	ID da pasta pai.
accessInherited	accessInherited	integer	Acessar o status da herança.
batchID	batchID	string	Identificador de Lote
DMS	dms	DmsDBO
id	id	integer	ID da pasta.
link	link	string	Link da pasta.
createddate	createddate	string	Data de criação.
modifieddate	modifieddate	string	Data modificada.
filho	child	integer	Pastas filho.
contagem de arquivos	filecount	integer	Número de arquivos.
criado por	createdby	UserDBO
modificado por	modifiedby	UserDBO
folderid	folderid	integer	ID da pasta.
dmsfolderid	dmsfolderid	string	Identificador da pasta DMS.
siteid	siteid	integer	ID do Site
local	location	string	Local da pasta.
permissão	permission	PermissionDBO
contentstatus	contentstatus	integer	Status do conteúdo.
numeração automática	autonumbering	string	Configuração de numeração automática.
foldersize	foldersize	string	Tamanho da pasta.
sharedstatus	sharedstatus	integer	Status de compartilhamento.
favoritestatus	favouritestatus	integer	Status favorito.
tipo de pasta	foldertype	string	Tipo de pasta.
ID do item	itemId	integer	ID do item.
folderMetadataSheetId	folderMetadataSheetId	integer	Metadados de pasta da ID da planilha.

UserDBO

Nome	Caminho	Tipo	Description
primeiro nome	firstname	string	Nome próprio.
sobrenome	lastname	string	Apelido.
email	email	string	Endereço de email.
userid	userid	integer	ID de usuário.

PermissionDBO

Nome	Caminho	Tipo	Description
exibição	view	integer	Permissão de exibição.
edição	edit	integer	Editar Permissão.
excluir	delete	integer	Excluir Permissão.
addEditAllFiles	addEditAllFiles	integer	Permissão Adicionar/Editar Todos os Arquivos.
administrador	admin	integer	Permissão de administrador.
viewAllFiles	viewAllFiles	integer	Exibir todos os arquivos Permissão.
disableSave	disableSave	integer	desabilite salvar a Permissão.
uploadFile	uploadFile	integer	permissão de upload do arquivo.
updateFile	updateFile	integer	atualizar a permissão do arquivo.
deleteFile	deleteFile	integer	Excluir permissão de arquivo.

ProgressiveKeyDBO

Nome	Caminho	Tipo	Description
progressivekey	progressivekey	string	Chave para operações progressivas.
siteid	siteid	integer	Identificador do site.
progressivekeystatus	progressivekeystatus	string	Status da chave progressiva.
userid	userid	integer	Identificador para o usuário.
responsebody	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
tipo de conteúdo	contentType	string	Tipo de conteúdo.
FailedEntities	failedEntities	integer	Número de entidades com falha.
downloadlink	downloadlink	string	Link para baixar conteúdo.
anexo	attachment	Attachment
link	link	string	Link associado.
documentid	documentid	integer	Identificador do documento.
progresskey	progresskey	string	Chave de progresso para acompanhamento.
progresskeystatus	progresskeystatus	string	Status da chave de progresso.

IntegrationResponseDBO

Nome	Caminho	Tipo	Description
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
FailedEntities	failedEntities	integer	Número de entidades que falharam no processamento.
successEntities	successEntities	integer	Número de entidades que foram processadas com êxito.

IntegrationResponseUsersObject

Nome	Caminho	Tipo	Description
usuário	user	array of IntegrationUserDBO

ColumnErrorsDBO

Nome	Caminho	Tipo	Description
coluna	column	array of ColumnErrorDBO
FailedEntities	failedEntities	integer	Número de entidades que falharam devido a erros de coluna.
successEntities	successEntities	integer	Número de entidades que foram processadas com êxito.

ColumnErrorDBO

Nome	Caminho	Tipo	Description
indexar	index	integer	Posição de índice da coluna com erro.
columnid	columnid	integer	Identificador exclusivo da coluna com erro.
nome	name	string	Nome da coluna com erro.
status	status	string	Status que indica a condição de erro.
statuscode	statuscode	string	Código que representa o status do erro.
mensagem	message	string	Mensagem de erro detalhada.

ItemErrorsDBO

Nome	Caminho	Tipo	Description
item	item	array of ItemErrorDBO
FailedEntities	failedEntities	integer	Número de entidades que falharam devido a erros de item.
successEntities	successEntities	integer	Número de entidades que foram processadas com êxito apesar dos erros de item.

ItemErrorDBO

Nome	Caminho	Tipo	Description
indexar	index	integer	Posição de í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.
status	status	string	Status que indica a condição de erro.
statuscode	statuscode	string	Código que representa o status do 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.
FailedEntities	failedEntities	integer	Número de entidades que falharam devido a erros de item.
successEntities	successEntities	integer	Número de entidades que foram processadas com êxito.

importISheetTemplateDBO

Nome	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 planilha à qual acrescentar dados.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
id do modelo	templateId	integer	Identificador do modelo.
templateTitle	templateTitle	string	Título do modelo.
viewIDs	viewIDs	string	Lista separada por vírgulas de IDs de exibição.

ISheetTemplateParameterGroups

Nome	Caminho	Tipo	Description
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Nome	Caminho	Tipo	Description
templateruleid	templateruleid	integer	Grupo de parâmetros do modelo Isheet.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Nome	Caminho	Tipo	Description
id	id	integer	Identificador do parâmetro de modelo de isheet.
nome	name	string	Nome do parâmetro de modelo de isheet.
dados	data	string	dados do parâmetro de modelo de isheet.

Anexo

Nome	Caminho	Tipo	Description
arquivo	file	string	O conteúdo do arquivo.
nome	name	string	O nome do anexo.
ordem	order	string	A ordem do anexo.
id	id	integer	Identificador exclusivo para o anexo.
extensão	extension	string	Extensão.
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.
folderhttplink	folderhttplink	string	Link HTTP para a pasta.
filesize	filesize	integer	Tamanho do arquivo em bytes.
redactionStatus	redactionStatus	boolean	Indica se o arquivo foi redigido.
displayname	displayname	string	Nome de exibição do anexo.
siteid	siteid	integer	ID do site associado ao anexo.

Compartilhar via

HighQ (versão prévia)

HighQ

Visão geral

Authentication

Operações do conector

Módulo ISheet

APIs de recurso de documento

API de Administração do ISheet

Operações do Usuário

Gerenciamento de Documentos e Sites

Introdução

Parâmetros e configurações

Solução de problemas e limitações

Recursos adicionais

Licenciamento e suporte

Limitações

Ações

Adicionar grupo existente ao site

Parâmetros

Retornos

Adicionar site

Parâmetros

Retornos

Adicionar usuário

Parâmetros

Retornos

Arquivar usuário

Parâmetros

Atualizar grupo de sites

Parâmetros

Retornos

Atualizar site

Parâmetros

Criar pasta

Parâmetros

Retornos

Fazer upload de um arquivo

Parâmetros

Mover documentos

Parâmetros

Obter informações da pasta

Parâmetros

Retornos

Para criar o item iSheet

Parâmetros

Retornos

Recuperar colunas iSheet

Parâmetros

Retornos

Recuperar informações do arquivo

Parâmetros

Retornos

Recuperar lista de usuários

Parâmetros

Retornos

Recuperar uma lista de itens do iSheet

Parâmetros

Retornos

Recuperar uma lista de pastas

Parâmetros

Retornos

Definições

ErrorDBO

DocumentDBO

columns

LocationDBO

UserName

MetadataListDBO

NameValueLink

Link

ExperiencesDBO

GroupsDBO

usuário

users

FolderDBOV1

DmsDBO

grupo de sites

Endereço

IntegrationUserDBO