HighQ (versión preliminar)

Este conector permite el acceso seguro y autenticado a las API de HighQ, lo que permite una integración sin problemas de las funcionalidades de colaboración y administración de contenido en flujos de trabajo y aplicaciones personalizados. Admite la automatización de documentos, la sincronización de datos y la orquestación de flujos de trabajo, lo que permite a los equipos de servicios legales y profesionales simplificar las operaciones, reducir el esfuerzo manual y mejorar la productividad.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Highq
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Correo Electrónico	highq-support@thomsonreuters.com

Metadatos del conector
Publicador	Thompson Reuters Incorporated
Sitio web	https://legal.thomsonreuters.com/en/products/highq
Directiva de privacidad	https://www.thomsonreuters.com/en/privacy-statement
Categorías	Colaboración; Contenido y archivos

HighQ

Información general

HighQ proporciona acceso sin problemas, seguro y autenticado a las API de HighQ. Este conector permite la interacción sin problemas con varios servicios de HighQ, como el módulo ISheet, las API de recursos de documentos, la API de administración de ISheet y las operaciones de usuario. Está diseñado para facilitar la integración con la plataforma HighQ Collaborate, ofreciendo funcionalidades como recuperar y crear elementos de iSheet, administrar archivos de documento y administrar cuentas de usuario.

Versión del conector: 1.0.0
Título: HighQ
Descripción: Este conector ofrece acceso sin problemas, seguro y autenticado a las API de HighQ.
Contacto:
- Nombre: Highq
- Sitio web:Soporte técnico de HighQ
- Correo electrónico:highq-support@thomsonreuters.com

Autenticación

El conector aprovecha las variables de entorno dinámico para la conectividad segura:

Host: @environmentVariables("highqt_host")
Ruta de acceso base: /@environmentVariables("highqt_instancename")/api
Id. de cliente:@environmentVariables("highqt_clientid")
Secreto de cliente:@environmentVariables("highqt_clientsecret")

Para obtener procedimientos de autenticación detallados, consulte el portal de soporte técnico de HighQ o póngase en contacto con el soporte técnico de HighQ.

Operaciones del conector

Módulo ISheet

Recuperar elementos de iSheet
GET /{version}/isheet/{isheetid}/items
Recupera una lista de elementos dentro del iSheet especificado.
Crear elementos de iSheet
POST /{version}/isheet/{isheetid}/items
Inserta nuevos elementos en un iSheet, con compatibilidad con varias iSheets y seguimiento de estado a través de claves progresivas.

API de recursos de documento

Recuperar información de archivo
GET /{version}/files/{fileid}
Recupera información detallada sobre un archivo específico en la plataforma HighQ Collaborate.
Cargar un archivo
POST /{version}/files/content
Carga un archivo en una carpeta especificada, lo que admite cargas fragmentadas cuando se proporciona el Content-Range encabezado.
Recuperar lista de carpetas
GET /{version}/folders/{folderid}/items
Recupera una lista de carpetas dentro de la carpeta especificada con compatibilidad con la ordenación y la paginación.

API de administración de ISheet

Recuperar columnas de iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Recupera configuraciones de columna para un iSheet determinado.

Operaciones de usuario

Recuperar usuarios
GET /{version}/users
Recupera una lista de usuarios compatibles con el filtrado, la paginación y los roles de usuario detallados.
Agregar un nuevo usuario
POST /{version}/users
Crea una nueva cuenta de usuario con atributos extendidos y validación.
Archivar un usuario
DELETE /{version}/users/{userid}
Archiva un usuario existente desde el sistema.

Administración de documentos y sitios

Crear una carpeta
POST /{version}/folders
Crea una nueva carpeta en una carpeta primaria especificada.
Mover documentos
PUT /{version}/files/move
Mueve uno o varios archivos de una carpeta a otra dentro del mismo sitio.
Operaciones de administración de sitios:
- Agregar grupo existente al sitio: POST /{version}/sites/{siteid}/groups/{groupid}
- Actualizar grupo de sitios: PUT /{version}/sites/{siteid}/groups/{groupid}
- Agregar un nuevo sitio: POST /{version}/sites

Introducción

Configuración:
- Defina las variables highqt_host de entorno y highqt_instancename en el entorno de Power Platform.
Autenticación:
- Siga las instrucciones proporcionadas por HighQ para configurar la autenticación segura para las solicitudes de API.
Uso:
- Importe HighQ en la instancia de Power Platform.
- Use las operaciones disponibles según sea necesario. Consulte los resúmenes de la operación proporcionados anteriormente para obtener instrucciones.

Parámetros y configuración

Parámetros de ruta de acceso:
Incluya los parámetros necesarios, como version, isheetid, fileid, folderidy userid según corresponda.
Parámetros de consulta:
Los parámetros opcionales como sheetviewid, sortcolumnid, limity offset están disponibles para refinar las respuestas de api.
Parámetros del cuerpo:
Para las operaciones que requieren un cuerpo de solicitud (por ejemplo, crear elementos o usuarios de iSheet), asegúrese de que la solicitud se adhiere a los esquemas definidos (como isheetDBO, FolderDBOo IntegrationUserDBO).

Solución de problemas y limitaciones

Códigos de error:
Los códigos de estado HTTP estándar se usan en todas las operaciones:
- 200 para operaciones correctas
- 401 para el acceso no autorizado
- 403 para errores de validación o prohibidos
- 405 para métodos HTTP no válidos
- 500 para errores internos del servidor
  Consulte la documentación de api individual para obtener descripciones detalladas de errores.
Limitaciones:
Algunos puntos de conexión pueden tener límites predeterminados (por ejemplo, un valor predeterminado limit de 100 registros). Es posible que se requieran parámetros adicionales para ordenar y filtrar grandes conjuntos de datos.

Recursos adicionales

Para obtener información más detallada y documentación extendida, consulte:

Soporte técnico de HighQ
Documentación interna que acompaña al paquete del conector HighQ.

Licencias y soporte técnico

Para obtener detalles de licencia y soporte técnico:

Contacto: Highq
Dirección URL de soporte técnico: Soporte técnico de HighQ
Correo electrónico de soporte técnico: highq-support@thomsonreuters.com

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualizar grupo de sitios

Este método de API actualiza el nombre de un grupo existente en un sitio.
Esta API se ha ampliado para actualizar el nombre de un grupo de usuarios básico existente en un sitio.

Actualizar sitio

Use este punto de conexión de API para actualizar los detalles de un sitio existente. La API admite los mismos campos que se usan en La API de creación de sitios.

Este método admite varios números de asunto para agregar en el sitio mediante la versión 10 de la API en adelante. La etiqueta "matternos" indica varios números de materia con solo lectura o no.

Versión 18 en adelante: se requiere una categoría (propósito del sitio). Si el propósito del sitio está oculto, se muestra un mensaje; de lo contrario, los propósitos ocultos del sitio no se agregan al sitio.

Ahora también se puede asignar el propietario del sitio a otros usuarios, pero deben ser participantes del sitio y tener un rol superior al administrador del sitio.

Versión 18 en adelante: el propietario del sitio puede agregar otros usuarios al sitio.

A partir de la versión 19 de la API, se introduce un nuevo módulo denominado customPages, que está estrechamente unido al módulo principal. Si el valor del módulo principal es True, customPages debe ser true y viceversa.

Tenga en cuenta que todas las propiedades o elementos de la respuesta get site no son actualizables o insertables. Consulte la tabla siguiente para saber cuáles son de solo lectura, actualizables o insertables.

Agregar sitio

Use esta API para crear un sitio. El objeto de sitio solo admite atributos que están visibles en la interfaz de creación de sitio.

Esta API requiere el nombre del sitio (y los campos obligatorios configurados en el nivel de ASP, si los hay) para crear un sitio.

La etiqueta "module" representa un módulo diferente para configurar en el sitio, tal como se muestra en los atributos de solicitud.
Para crear un sitio a partir de una plantilla, pase la etiqueta "sitetemplateid"
- Para menos de la versión 7, si no se proporciona ningún módulo (no se pasa la etiqueta "module") en la solicitud, se realizará la configuración del módulo de plantilla. Si se proporciona la etiqueta de módulo con la configuración, respetará y configurará como se indica en la solicitud (en lugar de usar la configuración del módulo de plantilla).
- Para mayor que la versión 7, si se proporciona algún módulo (se pasa la etiqueta "módulo") o no en la solicitud, se realizará la configuración del módulo de plantilla.

Este método no admite la carga de la imagen del sitio en esta llamada, la compatibilidad con el icono de sitio se proporcionará como una llamada independiente.
La llamada al método espera un identificador de categoría existente. El identificador de categoría debe obtenerse mediante la aplicación que realiza la llamada mediante una llamada anterior a la interfaz Categorías de sitio. Si no se proporcionan categorías en la solicitud, ninguna categoría (no real ninguna categoría) se agregará de forma predeterminada.

La fecha de inicio y finalización del sitio debe estar en el formato "dd MMM aaaa" y no es UTC. El cliente de API siempre solicitará la fecha real.

"landingpage" tiene el valor predeterminado como "archivos (carpeta raíz)".
"landingpage" espera tres palabras o identificaciones diferentes para el módulo Archivo. Los valores posibles son:
- archivos (carpeta raíz)
- archivos (actividad reciente)
- archivos (búsqueda avanzada)
La implementación del método ahora admite (desde la versión 5.1 en adelante) nombre de sitio multilingüe. La versión de API 6 o un nombre< de sitio superior >representará en el cuerpo de la solicitud en función del orden de preferencia del usuario. La versión de API 5 o un nombre de sitio< anterior >representará el inglés del Reino Unido predeterminado.
<sitenametranslations> representará nombres de sitio en todos los idiomas (que serán etiquetas adicionales en "API propia de objeto" de la versión 5.1 posterior) de la API versión 6 o posterior, en el cuerpo de la solicitud, están enviando ambas etiquetas, es decir<, sitename> y <sitenametranslations>, entonces necesitamos validar valores, por ejemplo, <sitename> debe coincidir con la etiqueta de traducción< correspondiente >en términos de preferencia de idioma del usuario. LA API 7 o posterior, el sitio creado a partir de la plantilla seguirá los módulos de la plantilla de origen y omitirá la lista de módulos enviada en el cuerpo de la solicitud.

La implementación del método ahora admite la creación de un sitio a partir de una plantilla proporcionando la etiqueta "sitetemplateid" (enfoque anterior)

Tenga en cuenta que la compatibilidad con la creación de un sitio a partir de una plantilla con esta API quedará en desuso en el futuro. Para crear un sitio a partir de una plantilla, use la nueva API Create site from template (/sites/templates/{templateid}/site) que es una API de sondeo larga (que tiene compatibilidad con solicitudes de larga duración)

Este método admite varios números de asunto para agregar en el sitio mediante la versión 10 de la API en adelante. La etiqueta "matternos" indica varios números de materia con solo lectura o no. La versión anterior (menor que la versión 10) del número de asunto único "matterno" reflejará el primer número de asunto existente de varios números de materia en el sitio.

Versión 18 en adelante: se requiere una categoría (propósito del sitio). Si el propósito del sitio está oculto, se muestra un mensaje; de lo contrario, los propósitos ocultos del sitio no se agregan al sitio.

Hasta la versión 17: el propietario del sitio es el usuario que ha iniciado sesión; no se puede agregar ningún otro usuario.

Versión 18 en adelante: el propietario del sitio puede agregar otros usuarios al sitio.

A partir de la versión 19 de la API, se introduce un nuevo módulo denominado "customPages", que está estrechamente unido al módulo principal. Por lo tanto, si el valor del módulo principal es True, customPages será true y viceversa.

Agregar un grupo existente al sitio

Este método de API agrega un grupo de sistema existente al sitio.
Esta API se ha ampliado para agregar grupos de usuarios básicos del sistema existentes (de tipo de sistema o organización) en el sitio.

Agregar usuario

Esta llamada API se usa para agregar un nuevo usuario al sistema.
Nota:
1. Se ha agregado compatibilidad con los siguientes campos nuevos.
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. La etiqueta de dirección se ha agregado en la versión 4 de la API

Resumen	Código ref (antes de V4)	Código ref (V4)
Se requiere la dirección de correo electrónico	101	101
Dirección de correo electrónico no válida	104	104
Se requiere el nombre	102	102
El número máximo de caracteres permitidos para el nombre debe estar comprendido entre 1 y 100.	102	352
La dirección de correo electrónico del secretario/asistente no es válida	104	353
El estado debe estar activo o inactivo	116	116
El departamento especificado no puede tener más de 256 caracteres.	N/A	354
El atributo ifpartner especificado no es válido	N/A	355
El atributo systemuser especificado no es válido	N/A	356
El atributo usertypeid especificado no es válido	N/A	357
El atributo langcode especificado no es válido	N/A	358
El atributo sourcetype especificado no es válido. Los valores válidos son System, Active Directory o System predeterminado.	N/A	359
Escriba un número de teléfono válido.	N/A	360
Escriba un número de teléfono válido en formato {countrycode} ${areacode}${number}.	N/A	361
Escriba un número de móvil válido en formato {countrycode}${number}.	N/A	362
Escriba un código de país de teléfono de oficina válido	N/A	363
El código de país del teléfono de la oficina puede tener un máximo de 4 dígitos	N/A	364
Escriba un código de área de teléfono de oficina válido.	N/A	365
El código del área de teléfono de la oficina puede tener un máximo de 5 dígitos.	N/A	366
El número de teléfono de oficina debe tener un máximo de 15 dígitos	N/A	368
Escriba un código de país de teléfono móvil válido.	N/A	369
El código de país del teléfono móvil puede tener un máximo de 4 dígitos.	N/A	372
Escriba un número de móvil válido.	N/A	373
El número de teléfono móvil debe tener un máximo de 20 dígitos	N/A	374
El dominio no existe	105	105
El correo electrónico ya existe en el sistema	111	111
Organización de menciones en caso de dominio auto registrado	187	187
Organización de menciones en caso de dominio excepcional	115	115
El identificador de la organización no está en el formato adecuado	112	112
La organización no existe	106	106
El dominio existe en otra organización	114	114
El identificador de dirección especificado no es válido	N/A	308
El nombre del vínculo social no se encuentra en el sistema.	N/A	375
Se requiere el nombre del vínculo social.	N/A	376
Se requiere el valor del vínculo social.	N/A	377
El número máximo de caracteres para el valor del vínculo social debe estar comprendido entre 1 y 500.	N/A	378
Escriba el nombre del vínculo personalizado.	N/A	379
Valor de vínculo personalizado necesario	N/A	380
Los caracteres máximos para el nombre de vínculo personalizado deben estar comprendidos entre 1 y 500.	N/A	381
Los caracteres máximos para el valor de vínculo personalizado deben estar comprendidos entre 1 y 500.	N/A	382
El nombre del vínculo de mensaje necesario	N/A	383
El nombre del vínculo de mensaje no se encuentra en el sistema	N/A	384
Valor de vínculo de mensaje necesario	N/A	385
Los caracteres máximos para el valor del vínculo de mensaje deben estar comprendidos entre 1 y 500.	N/A	386
El vínculo social está deshabilitado	N/A	408
El vínculo del mensaje está deshabilitado	N/A	409
El vínculo personalizado está deshabilitado	N/A	410

JiRA Ticket : https://dev.highq.com/jira/browse/COL-65685

Archivar usuario

Esta llamada API se usa para archivar un usuario dentro del sistema.

Códigos de error

Resumen	Código ref (antes de V4)	Código ref (V4)
Los siguientes usuarios no existen en el sistema	110	110
Se requiere un identificador de usuario	109	109
El identificador de usuario no tiene el formato adecuado	113	113
La longitud del identificador del usuario no puede superar los 50 caracteres.	N/A	304

JiRA Ticket : https://dev.highq.com/jira/browse/COL-67441

Carga de un archivo

Esta llamada API carga un archivo en una carpeta especificada en la plataforma HighQ Collaborate. Admite cargas fragmentadas cuando se proporciona el encabezado Content-Range.

Crear carpeta

Esta API crea una nueva carpeta dentro del sitio especificado. Permite proporcionar detalles de carpeta y garantiza que la carpeta se crea en la carpeta primaria especificada.

Mover documentos

Esta API mueve varios archivos de una carpeta a otra dentro del mismo sitio.

Obtener información de carpeta

El método proporciona detalles de carpeta del identificador de carpeta especificado.

Para crear el elemento de iSheet

Esta llamada API se usa para insertar elemento de iSheet. Se pueden admitir varias iSheets.

Para obtener el estado de un elemento de iSheet basado en una clave progresiva, llame a API POST /api/3/progressivekeystatus/{progressive_key}

Por ejemplo, POST /api/{version}/progressivekeystatus/{progressive_key}

Nombre	Tipo	Description
progressive_key	String	Clave para comprobar el estado de la acción.

Respuesta


              
              <progressivekeyresponse>

               \t<items>

                \t\t<item>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\t<status>SUCCESS</status>

                 \t\t\t<statuscode 200>/statuscode<>

                 \t\t\t<message>Record agregado correctamente</message>

                \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<message>Record agregado correctamente</message>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Recuperar columnas de iSheet

Esta llamada API recupera las columnas asociadas con el iSheet especificado. Esta funcionalidad se admite en la versión 3 y posteriores de la API.

Recuperar información de archivo

Esta llamada API recupera información detallada de un archivo especificado de la plataforma HighQ Collaborate.

Recuperar lista de usuarios

Recuperar una lista de usuarios Esta API recupera una lista de usuarios del sistema. Características clave de ## : captura los detalles del usuario con varias opciones de filtrado: admite la paginación con `limit` y `offset` : nuevos parámetros de consulta y campos introducidos en versiones recientes: respuesta estructurada con roles de usuario y atributos ## Nuevos parámetros de consulta (Version-Specific) - Introducidos en V12: : `systemAdminSearch`: cuando se establece `1`en , solo devuelve usuarios con el rol Administrador del sistema. - Introducido en V18: `userid`: acepta valores separados por comas (CSV). Actualizaciones del cuerpo de respuesta ## : nuevos campos agregados: - `emaildomain`, , `orginvitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, `publicprofile`, # `dateOfBirth` Cambio de formato de dirección (de V11): se ha cambiado el `location` nombre de la etiqueta por `address` para la coherencia. - Respuesta de ejemplo: `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>` ## Roles de usuario (introducidos en LA API V11+): respuesta de ejemplo: `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>` ## Límites y desplazamientos - Comportamiento de límite: - Valor predeterminado: `100` si no se proporciona ningún valor. - Use `-1` para devolver todos los registros. - Si el valor es menor que `-1`, el valor predeterminado es `100`. - Comportamiento de desplazamiento: - Valor predeterminado: `0` si no se proporciona ningún valor. - Si el desplazamiento supera el total de registros, el valor predeterminado vuelve a `0`. ## Nuevos roles introducidos: V12: `Basic User`, `Allow user to bypass XSS protection` - V14: `Allow user to manage Contract Express system groups` códigos de error ## | Resumen | Código ref (antes de V4) | Código ref (V4) | |---------|----------------------|--------------| | Entrada no válida para el estado del usuario (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | El identificador de organización no es válido | N/A | 260 | | Valor no válido `neverinvited` (true/false) | N/A | 387 | | Valor no válido `neverlogin` (true/false) | N/A | 388 | | Valor no válido `groupids` | N/A | 214 | | Valor no válido `notingroup` (true/false) | N/A | 389 | | No `ordertype` válido (admitido: nombre, organización, estado, etc.) | N/A | 289 | | No válido `orderby` (compatible: asc, desc) | N/A | 290 | | Valor no válido `offset` | 138 | 138 | | Valor no válido `limit` | 137 | 137 | ## Notas: desde la versión 13 y posteriores, esta API está abierta para todos los usuarios (anteriormente limitados a los administradores del sistema). - A partir de la versión 18, el `userregistered2FA` campo indica si un usuario se ha registrado para 2FA. --- Esta descripción sigue el formato de esquema de Swagger 2.0 y debe colocarse en el campo de descripción del esquema del conector personalizado.

Recuperar una lista de carpetas

Esta llamada API recupera una lista de carpetas contenidas en la carpeta especificada. El parámetro "limit" establece el número máximo de elementos que se van a devolver y el parámetro "offset" especifica la posición inicial para la recuperación de datos. Los valores predeterminados se aplican si se omiten estos parámetros y las carpetas se devuelven en orden ascendente por fecha de creación.

Recuperar una lista de elementos de iSheet

Esta llamada API recupera una lista de elementos contenidos en el iSheet especificado.

Actualizar grupo de sitios

Id. de la operación:: updateSiteGroup

Este método de API actualiza el nombre de un grupo existente en un sitio.
Esta API se ha ampliado para actualizar el nombre de un grupo de usuarios básico existente en un sitio.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	version
Identificador del sitio	siteid	True	string	Identificador del sitio.
Versión de la API	groupid	True	string	`The ID of the site group.`
nombre	name		string
id	id		integer
copypermissionsfrom	copypermissionsfrom		string
Mensaje	message		string
typeID	typeID		integer
type	type		string
numberofusers	numberofusers		string
creado	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
descripción	description		string
basicusergroup	basicusergroup		integer

Devoluciones

Body: sitegroup

Actualizar sitio

Id. de la operación:: updateSite

Use este punto de conexión de API para actualizar los detalles de un sitio existente. La API admite los mismos campos que se usan en La API de creación de sitios.

Este método admite varios números de asunto para agregar en el sitio mediante la versión 10 de la API en adelante. La etiqueta "matternos" indica varios números de materia con solo lectura o no.

Ahora también se puede asignar el propietario del sitio a otros usuarios, pero deben ser participantes del sitio y tener un rol superior al administrador del sitio.

Versión 18 en adelante: el propietario del sitio puede agregar otros usuarios al sitio.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
La versión de la API que se solicita	version	True	string	versión de api
Identificador único del sitio	siteid	True	string	Identificador del sitio
id	id		integer	Identificador del sitio.
sitename	sitename		string	El nombre del sitio.
role	role		string	Rol del sitio.
sitedescription	sitedescription		string	Descripción del sitio.
enabledmodules	enabledmodules		string	Lista de módulos habilitados para el sitio.
sitefolderID	sitefolderID		string	Identificador de la carpeta del sitio.
sitefolderpermission	sitefolderpermission		string	Nivel de permiso para la carpeta del sitio.
habilitar	enable		string	Habilite el estado de HomeDBO.
habilitar	enable		string	Habilite el estado de ActivityDBO.
microblog	microblog		string	Contenido de Microblog asociado a ActivityDBO.
docid	docid		string	Id. de documento.
blogTitle	blogTitle		string	Título de la entrada de blog.
blogContent	blogContent		string	Contenido de la entrada de blog.
showComment	showComment		integer	mostrar el comentario.
tagList	tagList		array of string	Lista de etiquetas asociadas al blog.
estado	status		integer	estado de la entrada de blog.
siteID	siteID		integer	Identificador del sitio asociado.
autor	author		string	Autor del blog.
categoryList	categoryList		array of string	Categorías asignadas a la entrada de blog.
notificationTypeID	notificationTypeID		integer	Identificador del tipo de notificación.
Mensaje	message		string	Contenido del mensaje relacionado con el blog.
messageCode	messageCode		integer	Código asociado al mensaje.
externalId	externalID		string	Identificador externo vinculado al blog.
publishDate	publishDate		string	Fecha de publicación del blog.
processtype	processtype		string	Tipo de proceso asociado al blog.
habilitar	enable		string	Habilite el estado de BlogDBO.
wikiid	wikiid		integer	Identificador único de la wiki.
currentversionid	currentversionid		integer	Identificador de la versión actual de la wiki
parentwikiid	parentwikiid		integer	Identificador de la wiki primaria.
wikititle	wikititle		string	Título de la wiki.
wikicontent	wikicontent		string	Contenido de la wiki.
showcomment	showcomment		integer	Indica si los comentarios están habilitados.
createddate	createddate		string	Fecha de creación de la wiki.
modifieddate	modifieddate		string	Fecha de última modificación de la wiki.
taglist	taglist		string	Lista separada por comas de etiquetas asociadas a la wiki.
wikipath	wikipath		string	Ruta de acceso para acceder a la wiki.
wikidraftid	wikidraftid		integer	Identificador de la versión de borrador de la wiki.
drafttype	drafttype		string	Tipo de borrador asociado a la wiki.
estado	status		integer	Estado actual de la wiki.
wikiversionid	wikiversionid		integer	Identificador de versión de la wiki.
index	index		string	Índice o identificador de la tarea.
parenttaskid	parenttaskid		integer	Identificador de la tarea primaria.
taskid	taskid		integer	Identificador único de la tarea.
title	title		string	Título de la tarea.
descripción	description		string	Descripción detallada de la tarea.
duedate	duedate		string	Fecha de vencimiento para la finalización de la tarea.
startdate	startdate		string	Fecha de inicio en la que se inició la tarea.
mattermaptaskid	mattermaptaskid		string	Identificador que vincula a la tarea de asignación de materia.
type	type		string	Tipo o categoría de la tarea.
dependenton	dependenton		string	Tareas de las que depende esta tarea.
daysfromdependent	daysfromdependent		string	Número de días de la tarea dependiente.
ignoreweekend	ignoreweekend		integer	Indica si los fines de semana se omiten en la programación.
duration	duration		integer	Duración para completar la tarea.
resource	resource		string	Recursos asignados a la tarea.
eventTitle	eventTitle		string	Título del evento.
eventContent	eventContent		string	Contenido del evento.
showComment	showComment		integer	Indica si los comentarios están habilitados para el evento.
tagList	tagList		array of string	Lista de etiquetas asociadas al evento.
estado	status		integer	Estado actual del evento.
siteID	siteID		integer	Identificador del sitio.
contacto	contact		string	Información de contacto del evento.
categoryList	categoryList		array of string	Categorías en las que se muestra el evento.
notificationTypeID	notificationTypeID		integer	Tipo de notificación relacionado con el evento.
Mensaje	message		string	Mensaje del evento.
messageCode	messageCode		integer	Código de mensaje del evento.
externalId	externalID		string	Identificador externo.
startDate	startDate		string	Fecha de inicio del evento.
fecha de finalización	endDate		string	Fecha de finalización del evento.
startTime	startTime		string	Hora de inicio del evento.
endTime	endTime		string	Hora de finalización del evento.
location	location		string	Ubicación del evento.
autor	author		string	Autor del evento.
processtype	processtype		string	Tiempo de proceso del evento.
habilitar	enable		string	Habilite el evento.
id	id		integer	Identificador único de iSheet.
title	title		string	Título de iSheet.
descripción	description		string	Descripción de la hoja isheet.
estado	status		string	Estado de la hoja isheet.
accesstype	accesstype		string	Tipo de acceso de la hoja isheet.
type	type		string	Tipo de la hoja isheet.
viewlink	viewlink		string	Vínculo para ver iSheet.
allowsections	allowsections		string	Indica si se permiten secciones.
allowlookup	allowlookup		string	Si los campos de búsqueda están habilitados.
displayisheet	displayisheet		string	Mostrar las opciones de iSheet.
searchasdefaultview	searchasdefaultview		string	Indica si la búsqueda es la vista predeterminada.
enableversion	enableversion		string	Marca habilitada para control de versiones.
enablesheetalerter	enablesheetalerter		string	Marca para habilitar las alertas de hoja.
alertercondition	alertercondition		string	Condiciones para desencadenar alertas.
overrideitemmodifieddate	overrideitemmodifieddate		string	Invalide la marca de fecha modificada.
enablebulkinsertupdate	enablebulkinsertupdate		string	Habilite la inserción o actualización masiva.
fielddescriptions	fielddescriptions		string	Descripciones de campo para iSheet.
enablerowlocking	enablerowlocking		string	Habilite el bloqueo de nivel de fila.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Truncar la marca de texto de varias líneas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Límite de caracteres para el truncamiento de varias líneas.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permitir la reutilización de valores de lista de opciones.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permitir la reutilización de los valores de la lista de puntuación.
allowIsheetComments	allowIsheetComments		string	Permitir comentarios en iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Límite de registros permitidos para compartir.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Límite de recursos compartidos de registros habilitados.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Habilite el uso compartido de formularios para agregar registros.
recordcount	recordcount		string	Recuento de registros actual.
sheettypeid	sheettypeid		integer	Identificador de tipo de iSheet
habilitar	enable		string	Habilite la funcionalidad qa.
userid	userid		integer	Id. de usuario
Correo electrónico	email		string	dirección de correo electrónico.
httpavatar	httpavatar		string	DIRECCIÓN URL HTTP del avatar.
avatar	avatar		string	Imagen de avatar.
userlink	userlink		string	Vínculo al perfil de usuario.
httplink	httplink		string	Vínculo HTTP al perfil de usuario.
phone	phone		string	Número de teléfono.
mobile	mobile		string	Número de móvil.
departamento	department		string	Departamento del usuario.
habilitar	enable		string	Habilite la integración de Contract Express.
adminnote	adminnote		string	Notas administrativas relacionadas con el sitio.
startdate	startdate		string	Fecha de inicio de la operación del sitio.
enddate	enddate		string	Fecha de finalización de la operación del sitio.
createddate	createddate		string	Fecha en que se creó el sitio.
archiveddate	archiveddate		string	Fecha en la que se ha archivado el sitio.
clientno	clientno		string	Número de cliente asociado al sitio.
matterno	matterno		string	Número de asunto asociado al sitio.
página de aterrizaje	landingpage		string	Dirección URL de la página de aterrizaje del sitio.
link	link		string	Vínculo relacionado con el sitio.
estado	status		string	Estado actual del sitio.
statusid	statusid		integer	Identificador del estado del sitio.
size	size		string	Tamaño del sitio.
billingnotes	billingnotes		string	Notas relacionadas con la facturación del sitio.
billingnextinvoicedate	billingnextinvoicedate		string	Fecha de la siguiente factura del sitio.
billinglastinvoicedate	billinglastinvoicedate		string	Fecha de la última factura del sitio.
filepagecount	filepagecount		string	Recuento total de páginas de archivos en el sitio.
maxpagecount	maxpagecount		string	Número máximo permitido de páginas para archivos en el sitio.
sitehttplink	sitehttplink		string	Vínculo HTTP al sitio.
isSyncable	isSyncable		integer	Indica si el sitio es sincronizable.
enforceusergroups	enforceusergroups		string	Los grupos de usuarios aplicados para el sitio.
csvSiteCategory	csvSiteCategory		string	Categoría del sitio en formato CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Nombre del sitio en el idioma predeterminado.
visible	visible		integer	Indica si el sitio está visible.
siteLogoName	siteLogoName		string	Nombre del archivo de logotipo del sitio.
siteLogoFileSize	siteLogoFileSize		integer	Tamaño del archivo del logotipo del sitio.
siteLogoHeight	siteLogoHeight		integer	Alto del logotipo del sitio.
siteLogoWidth	siteLogoWidth		integer	Ancho del logotipo del sitio.
siteStatus	siteStatus		integer	Código de estado del sitio.
applySiteTerms	applySiteTerms		integer	Indica si se aplican los términos del sitio.
siteTerm	siteTerm		string	Los términos aplicados al sitio.
termType	termType		integer	Tipo de términos aplicados al sitio.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indica si los términos del sitio son necesarios en el siguiente inicio de sesión.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indica si los términos de sitio predeterminados están habilitados.
advancedQAPermission	advancedQAPermission		integer	Nivel de permiso de control de calidad avanzado para el sitio.
isInternal	isInternal		integer	Indica si el sitio es interno.
Psm	psm		integer	Identificador de Product Service Manager.
siteLabelDisplay	siteLabelDisplay		string	Etiqueta para mostrar del sitio.
allowSiteAdministration	allowSiteAdministration		integer	Indica si se permite la administración del sitio.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Para habilitar la protección con contraseña de nivel de sitio.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Para habilitar la protección de código de acceso de nivel de sitio.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Indica si la autenticación de código de acceso usa una aplicación de autenticación.
sitePassword	sitePassword		string	Contraseña asociada al sitio.
ipRestrictionEnable	ipRestrictionEnable		integer	Para habilitar las restricciones de IP para el acceso al sitio.
availableIP	availableIP		string	Lista separada por comas de direcciones IP permitidas para acceder al sitio.
highqDrive	highqDrive		integer	Indica si la integración de HighQ Drive está habilitada.
applySiteHomePage	applySiteHomePage		integer	Para aplicar una página principal personalizada para el sitio.
siteHomePage	siteHomePage		string	Dirección URL de la página principal personalizada del sitio.
siteHomePageType	siteHomePageType		integer	Tipo de la página principal.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Para establecer el siguiente inicio de sesión en la página principal del sitio.
applyDisplayContent	applyDisplayContent		integer	Para aplicar la configuración de contenido para mostrar.
displayContent	displayContent		string	Contenido que se va a mostrar en el sitio.
rssSecurity	rssSecurity		integer	Nivel de seguridad de fuente RSS.
encryptedPassword	encryptedPassword		integer	Indica si la contraseña del sitio está cifrada.
availableIPRangeCSV	availableIPRangeCSV		string	Lista separada por comas de intervalos de direcciones IP permitidos para acceder al sitio.
siteModuleID	siteModuleID		integer	Identificador del módulo de sitio.
icalSecurity	icalSecurity		integer	Nivel de seguridad de fuente iCal.
defaultDisplayContent	defaultDisplayContent		string	Contenido predeterminado que se va a mostrar en el sitio.
defaultEmailAlert	defaultEmailAlert		integer	Para habilitar las alertas de correo electrónico predeterminadas.
excelReportFooter	excelReportFooter		integer	Incluye un pie de página en informes de Excel.
excelReportFooterText	excelReportFooterText		string	Texto que se va a mostrar en el pie de página de los informes de Excel.
announcementMLJSON	announcementMLJSON		string	Anuncios con formato JSON para el sitio.
templateType	templateType		integer	Tipo de plantilla usada para el sitio.
templateLicence	templateLicence		integer	Tipo de licencia para la plantilla de sitio.
openChannelAppID	openChannelAppID		string	Identificador de aplicación para la integración del canal abierto.
itemid	itemid		integer	Identificador del elemento asociado al sitio.
sitemetadatasheetid	sitemetadatasheetid		integer	Id. de la hoja de metadatos asociada al sitio.
mysite	mysite		boolean	Indica si se trata del sitio personal del usuario.
lastaccesseddate	lastaccesseddate		string	Fecha y hora en que se accedió por última vez al sitio.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Pestaña metadatos predeterminados para el visor del sitio.
documentMetadataViewId	documentMetadataViewId		integer	metadatos de documento para el identificador de vista.
folderMetadataViewId	folderMetadataViewId		integer	metadatos de carpeta para el identificador de vista.
docSort	docSort		integer	Criterio de ordenación de documentos.
folderSort	folderSort		integer	Criterio de ordenación de carpetas.
defaultFolderRenderView	defaultFolderRenderView		integer	Determina el modo de vista predeterminado para las carpetas.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Ubicación predeterminada para los datos adjuntos de la tarea.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Identificador único de la carpeta designada como ubicación predeterminada para los datos adjuntos de la tarea.
favorito	favourite		string	estado favorito.
enabledocumentredaction	enabledocumentredaction		boolean	Especifica si la reacción de documentos está habilitada para el sitio.
mentiongroups	mentiongroups		integer	Los grupos mencionados.
enablefilerelationships	enablefilerelationships		boolean	Indica si las relaciones de archivo están habilitadas.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Nivel de permiso necesario para administrar las relaciones de archivo.

Agregar sitio

Id. de la operación:: createSite

Parámetros

Nombre	Clave	Requerido	Tipo	Description
La versión de la API que se solicita	version	True	string	versión de api
id	id		integer	Identificador del sitio.
sitename	sitename		string	El nombre del sitio.
role	role		string	Rol del sitio.
sitedescription	sitedescription		string	Descripción del sitio.
enabledmodules	enabledmodules		string	Lista de módulos habilitados para el sitio.
sitefolderID	sitefolderID		string	Identificador de la carpeta del sitio.
sitefolderpermission	sitefolderpermission		string	Nivel de permiso para la carpeta del sitio.
habilitar	enable		string	Habilite el estado de HomeDBO.
habilitar	enable		string	Habilite el estado de ActivityDBO.
microblog	microblog		string	Contenido de Microblog asociado a ActivityDBO.
docid	docid		string	Id. de documento.
blogTitle	blogTitle		string	Título de la entrada de blog.
blogContent	blogContent		string	Contenido de la entrada de blog.
showComment	showComment		integer	mostrar el comentario.
tagList	tagList		array of string	Lista de etiquetas asociadas al blog.
estado	status		integer	estado de la entrada de blog.
siteID	siteID		integer	Identificador del sitio asociado.
autor	author		string	Autor del blog.
categoryList	categoryList		array of string	Categorías asignadas a la entrada de blog.
notificationTypeID	notificationTypeID		integer	Identificador del tipo de notificación.
Mensaje	message		string	Contenido del mensaje relacionado con el blog.
messageCode	messageCode		integer	Código asociado al mensaje.
externalId	externalID		string	Identificador externo vinculado al blog.
publishDate	publishDate		string	Fecha de publicación del blog.
processtype	processtype		string	Tipo de proceso asociado al blog.
habilitar	enable		string	Habilite el estado de BlogDBO.
wikiid	wikiid		integer	Identificador único de la wiki.
currentversionid	currentversionid		integer	Identificador de la versión actual de la wiki
parentwikiid	parentwikiid		integer	Identificador de la wiki primaria.
wikititle	wikititle		string	Título de la wiki.
wikicontent	wikicontent		string	Contenido de la wiki.
showcomment	showcomment		integer	Indica si los comentarios están habilitados.
createddate	createddate		string	Fecha de creación de la wiki.
modifieddate	modifieddate		string	Fecha de última modificación de la wiki.
taglist	taglist		string	Lista separada por comas de etiquetas asociadas a la wiki.
wikipath	wikipath		string	Ruta de acceso para acceder a la wiki.
wikidraftid	wikidraftid		integer	Identificador de la versión de borrador de la wiki.
drafttype	drafttype		string	Tipo de borrador asociado a la wiki.
estado	status		integer	Estado actual de la wiki.
wikiversionid	wikiversionid		integer	Identificador de versión de la wiki.
index	index		string	Índice o identificador de la tarea.
parenttaskid	parenttaskid		integer	Identificador de la tarea primaria.
taskid	taskid		integer	Identificador único de la tarea.
title	title		string	Título de la tarea.
descripción	description		string	Descripción detallada de la tarea.
duedate	duedate		string	Fecha de vencimiento para la finalización de la tarea.
startdate	startdate		string	Fecha de inicio en la que se inició la tarea.
mattermaptaskid	mattermaptaskid		string	Identificador que vincula a la tarea de asignación de materia.
type	type		string	Tipo o categoría de la tarea.
dependenton	dependenton		string	Tareas de las que depende esta tarea.
daysfromdependent	daysfromdependent		string	Número de días de la tarea dependiente.
ignoreweekend	ignoreweekend		integer	Indica si los fines de semana se omiten en la programación.
duration	duration		integer	Duración para completar la tarea.
resource	resource		string	Recursos asignados a la tarea.
eventTitle	eventTitle		string	Título del evento.
eventContent	eventContent		string	Contenido del evento.
showComment	showComment		integer	Indica si los comentarios están habilitados para el evento.
tagList	tagList		array of string	Lista de etiquetas asociadas al evento.
estado	status		integer	Estado actual del evento.
siteID	siteID		integer	Identificador del sitio.
contacto	contact		string	Información de contacto del evento.
categoryList	categoryList		array of string	Categorías en las que se muestra el evento.
notificationTypeID	notificationTypeID		integer	Tipo de notificación relacionado con el evento.
Mensaje	message		string	Mensaje del evento.
messageCode	messageCode		integer	Código de mensaje del evento.
externalId	externalID		string	Identificador externo.
startDate	startDate		string	Fecha de inicio del evento.
fecha de finalización	endDate		string	Fecha de finalización del evento.
startTime	startTime		string	Hora de inicio del evento.
endTime	endTime		string	Hora de finalización del evento.
location	location		string	Ubicación del evento.
autor	author		string	Autor del evento.
processtype	processtype		string	Tiempo de proceso del evento.
habilitar	enable		string	Habilite el evento.
id	id		integer	Identificador único de iSheet.
title	title		string	Título de iSheet.
descripción	description		string	Descripción de la hoja isheet.
estado	status		string	Estado de la hoja isheet.
accesstype	accesstype		string	Tipo de acceso de la hoja isheet.
type	type		string	Tipo de la hoja isheet.
viewlink	viewlink		string	Vínculo para ver iSheet.
allowsections	allowsections		string	Indica si se permiten secciones.
allowlookup	allowlookup		string	Si los campos de búsqueda están habilitados.
displayisheet	displayisheet		string	Mostrar las opciones de iSheet.
searchasdefaultview	searchasdefaultview		string	Indica si la búsqueda es la vista predeterminada.
enableversion	enableversion		string	Marca habilitada para control de versiones.
enablesheetalerter	enablesheetalerter		string	Marca para habilitar las alertas de hoja.
alertercondition	alertercondition		string	Condiciones para desencadenar alertas.
overrideitemmodifieddate	overrideitemmodifieddate		string	Invalide la marca de fecha modificada.
enablebulkinsertupdate	enablebulkinsertupdate		string	Habilite la inserción o actualización masiva.
fielddescriptions	fielddescriptions		string	Descripciones de campo para iSheet.
enablerowlocking	enablerowlocking		string	Habilite el bloqueo de nivel de fila.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Truncar la marca de texto de varias líneas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Límite de caracteres para el truncamiento de varias líneas.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permitir la reutilización de valores de lista de opciones.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permitir la reutilización de los valores de la lista de puntuación.
allowIsheetComments	allowIsheetComments		string	Permitir comentarios en iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Límite de registros permitidos para compartir.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Límite de recursos compartidos de registros habilitados.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Habilite el uso compartido de formularios para agregar registros.
recordcount	recordcount		string	Recuento de registros actual.
sheettypeid	sheettypeid		integer	Identificador de tipo de iSheet
habilitar	enable		string	Habilite la funcionalidad qa.
userid	userid		integer	Id. de usuario
Correo electrónico	email		string	dirección de correo electrónico.
httpavatar	httpavatar		string	DIRECCIÓN URL HTTP del avatar.
avatar	avatar		string	Imagen de avatar.
userlink	userlink		string	Vínculo al perfil de usuario.
httplink	httplink		string	Vínculo HTTP al perfil de usuario.
phone	phone		string	Número de teléfono.
mobile	mobile		string	Número de móvil.
departamento	department		string	Departamento del usuario.
habilitar	enable		string	Habilite la integración de Contract Express.
adminnote	adminnote		string	Notas administrativas relacionadas con el sitio.
startdate	startdate		string	Fecha de inicio de la operación del sitio.
enddate	enddate		string	Fecha de finalización de la operación del sitio.
createddate	createddate		string	Fecha en que se creó el sitio.
archiveddate	archiveddate		string	Fecha en la que se ha archivado el sitio.
clientno	clientno		string	Número de cliente asociado al sitio.
matterno	matterno		string	Número de asunto asociado al sitio.
página de aterrizaje	landingpage		string	Dirección URL de la página de aterrizaje del sitio.
link	link		string	Vínculo relacionado con el sitio.
estado	status		string	Estado actual del sitio.
statusid	statusid		integer	Identificador del estado del sitio.
size	size		string	Tamaño del sitio.
billingnotes	billingnotes		string	Notas relacionadas con la facturación del sitio.
billingnextinvoicedate	billingnextinvoicedate		string	Fecha de la siguiente factura del sitio.
billinglastinvoicedate	billinglastinvoicedate		string	Fecha de la última factura del sitio.
filepagecount	filepagecount		string	Recuento total de páginas de archivos en el sitio.
maxpagecount	maxpagecount		string	Número máximo permitido de páginas para archivos en el sitio.
sitehttplink	sitehttplink		string	Vínculo HTTP al sitio.
isSyncable	isSyncable		integer	Indica si el sitio es sincronizable.
enforceusergroups	enforceusergroups		string	Los grupos de usuarios aplicados para el sitio.
csvSiteCategory	csvSiteCategory		string	Categoría del sitio en formato CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Nombre del sitio en el idioma predeterminado.
visible	visible		integer	Indica si el sitio está visible.
siteLogoName	siteLogoName		string	Nombre del archivo de logotipo del sitio.
siteLogoFileSize	siteLogoFileSize		integer	Tamaño del archivo del logotipo del sitio.
siteLogoHeight	siteLogoHeight		integer	Alto del logotipo del sitio.
siteLogoWidth	siteLogoWidth		integer	Ancho del logotipo del sitio.
siteStatus	siteStatus		integer	Código de estado del sitio.
applySiteTerms	applySiteTerms		integer	Indica si se aplican los términos del sitio.
siteTerm	siteTerm		string	Los términos aplicados al sitio.
termType	termType		integer	Tipo de términos aplicados al sitio.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Indica si los términos del sitio son necesarios en el siguiente inicio de sesión.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Indica si los términos de sitio predeterminados están habilitados.
advancedQAPermission	advancedQAPermission		integer	Nivel de permiso de control de calidad avanzado para el sitio.
isInternal	isInternal		integer	Indica si el sitio es interno.
Psm	psm		integer	Identificador de Product Service Manager.
siteLabelDisplay	siteLabelDisplay		string	Etiqueta para mostrar del sitio.
allowSiteAdministration	allowSiteAdministration		integer	Indica si se permite la administración del sitio.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Para habilitar la protección con contraseña de nivel de sitio.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Para habilitar la protección de código de acceso de nivel de sitio.
passcodeUsingAuthApp	passcodeUsingAuthApp		integer	Indica si la autenticación de código de acceso usa una aplicación de autenticación.
sitePassword	sitePassword		string	Contraseña asociada al sitio.
ipRestrictionEnable	ipRestrictionEnable		integer	Para habilitar las restricciones de IP para el acceso al sitio.
availableIP	availableIP		string	Lista separada por comas de direcciones IP permitidas para acceder al sitio.
highqDrive	highqDrive		integer	Indica si la integración de HighQ Drive está habilitada.
applySiteHomePage	applySiteHomePage		integer	Para aplicar una página principal personalizada para el sitio.
siteHomePage	siteHomePage		string	Dirección URL de la página principal personalizada del sitio.
siteHomePageType	siteHomePageType		integer	Tipo de la página principal.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Para establecer el siguiente inicio de sesión en la página principal del sitio.
applyDisplayContent	applyDisplayContent		integer	Para aplicar la configuración de contenido para mostrar.
displayContent	displayContent		string	Contenido que se va a mostrar en el sitio.
rssSecurity	rssSecurity		integer	Nivel de seguridad de fuente RSS.
encryptedPassword	encryptedPassword		integer	Indica si la contraseña del sitio está cifrada.
availableIPRangeCSV	availableIPRangeCSV		string	Lista separada por comas de intervalos de direcciones IP permitidos para acceder al sitio.
siteModuleID	siteModuleID		integer	Identificador del módulo de sitio.
icalSecurity	icalSecurity		integer	Nivel de seguridad de fuente iCal.
defaultDisplayContent	defaultDisplayContent		string	Contenido predeterminado que se va a mostrar en el sitio.
defaultEmailAlert	defaultEmailAlert		integer	Para habilitar las alertas de correo electrónico predeterminadas.
excelReportFooter	excelReportFooter		integer	Incluye un pie de página en informes de Excel.
excelReportFooterText	excelReportFooterText		string	Texto que se va a mostrar en el pie de página de los informes de Excel.
announcementMLJSON	announcementMLJSON		string	Anuncios con formato JSON para el sitio.
templateType	templateType		integer	Tipo de plantilla usada para el sitio.
templateLicence	templateLicence		integer	Tipo de licencia para la plantilla de sitio.
openChannelAppID	openChannelAppID		string	Identificador de aplicación para la integración del canal abierto.
itemid	itemid		integer	Identificador del elemento asociado al sitio.
sitemetadatasheetid	sitemetadatasheetid		integer	Id. de la hoja de metadatos asociada al sitio.
mysite	mysite		boolean	Indica si se trata del sitio personal del usuario.
lastaccesseddate	lastaccesseddate		string	Fecha y hora en que se accedió por última vez al sitio.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Pestaña metadatos predeterminados para el visor del sitio.
documentMetadataViewId	documentMetadataViewId		integer	metadatos de documento para el identificador de vista.
folderMetadataViewId	folderMetadataViewId		integer	metadatos de carpeta para el identificador de vista.
docSort	docSort		integer	Criterio de ordenación de documentos.
folderSort	folderSort		integer	Criterio de ordenación de carpetas.
defaultFolderRenderView	defaultFolderRenderView		integer	Determina el modo de vista predeterminado para las carpetas.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Ubicación predeterminada para los datos adjuntos de la tarea.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Identificador único de la carpeta designada como ubicación predeterminada para los datos adjuntos de la tarea.
favorito	favourite		string	estado favorito.
enabledocumentredaction	enabledocumentredaction		boolean	Especifica si la reacción de documentos está habilitada para el sitio.
mentiongroups	mentiongroups		integer	Los grupos mencionados.
enablefilerelationships	enablefilerelationships		boolean	Indica si las relaciones de archivo están habilitadas.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Nivel de permiso necesario para administrar las relaciones de archivo.

Devoluciones

Body: site

Agregar un grupo existente al sitio

Id. de la operación:: addExistingGroupToSite

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	version
Identificador del sitio	siteid	True	string	Identificador del sitio.
Identificador del grupo del sistema	groupid	True	string	Identificador del grupo del sistema que se va a agregar al sitio.

Devoluciones

Body: sitegroup

Agregar usuario

Id. de la operación:: createUser

Resumen	Código ref (antes de V4)	Código ref (V4)
Se requiere la dirección de correo electrónico	101	101
Dirección de correo electrónico no válida	104	104
Se requiere el nombre	102	102
El número máximo de caracteres permitidos para el nombre debe estar comprendido entre 1 y 100.	102	352
La dirección de correo electrónico del secretario/asistente no es válida	104	353
El estado debe estar activo o inactivo	116	116
El departamento especificado no puede tener más de 256 caracteres.	N/A	354
El atributo ifpartner especificado no es válido	N/A	355
El atributo systemuser especificado no es válido	N/A	356
El atributo usertypeid especificado no es válido	N/A	357
El atributo langcode especificado no es válido	N/A	358
El atributo sourcetype especificado no es válido. Los valores válidos son System, Active Directory o System predeterminado.	N/A	359
Escriba un número de teléfono válido.	N/A	360
Escriba un número de teléfono válido en formato {countrycode} ${areacode}${number}.	N/A	361
Escriba un número de móvil válido en formato {countrycode}${number}.	N/A	362
Escriba un código de país de teléfono de oficina válido	N/A	363
El código de país del teléfono de la oficina puede tener un máximo de 4 dígitos	N/A	364
Escriba un código de área de teléfono de oficina válido.	N/A	365
El código del área de teléfono de la oficina puede tener un máximo de 5 dígitos.	N/A	366
El número de teléfono de oficina debe tener un máximo de 15 dígitos	N/A	368
Escriba un código de país de teléfono móvil válido.	N/A	369
El código de país del teléfono móvil puede tener un máximo de 4 dígitos.	N/A	372
Escriba un número de móvil válido.	N/A	373
El número de teléfono móvil debe tener un máximo de 20 dígitos	N/A	374
El dominio no existe	105	105
El correo electrónico ya existe en el sistema	111	111
Organización de menciones en caso de dominio auto registrado	187	187
Organización de menciones en caso de dominio excepcional	115	115
El identificador de la organización no está en el formato adecuado	112	112
La organización no existe	106	106
El dominio existe en otra organización	114	114
El identificador de dirección especificado no es válido	N/A	308
El nombre del vínculo social no se encuentra en el sistema.	N/A	375
Se requiere el nombre del vínculo social.	N/A	376
Se requiere el valor del vínculo social.	N/A	377
El número máximo de caracteres para el valor del vínculo social debe estar comprendido entre 1 y 500.	N/A	378
Escriba el nombre del vínculo personalizado.	N/A	379
Valor de vínculo personalizado necesario	N/A	380
Los caracteres máximos para el nombre de vínculo personalizado deben estar comprendidos entre 1 y 500.	N/A	381
Los caracteres máximos para el valor de vínculo personalizado deben estar comprendidos entre 1 y 500.	N/A	382
El nombre del vínculo de mensaje necesario	N/A	383
El nombre del vínculo de mensaje no se encuentra en el sistema	N/A	384
Valor de vínculo de mensaje necesario	N/A	385
Los caracteres máximos para el valor del vínculo de mensaje deben estar comprendidos entre 1 y 500.	N/A	386
El vínculo social está deshabilitado	N/A	408
El vínculo del mensaje está deshabilitado	N/A	409
El vínculo personalizado está deshabilitado	N/A	410

JiRA Ticket : https://dev.highq.com/jira/browse/COL-65685

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	versión de api
index	index		integer	Índice único para el usuario.
userid	userid		integer	Identificador único para el usuario.
nombre de pila	firstname		string	Nombre del usuario.
apellido	lastname		string	Apellidos del usuario.
practicegroup	practicegroup		string	Grupo de práctica al que pertenece el usuario.
langcode	langcode		string	Código de idioma del usuario.
localeID	localeID		string	Identificador de configuración regional del usuario.
publicprofile	publicprofile		string	Perfil público del usuario.
pwpid	pwpid		string	Id. de PWP del usuario.
usertypeid	usertypeid		string	Identificador de tipo de usuario.
systemuser	systemuser		string	Marca de usuario del sistema.
Correo electrónico	email		string	Email dirección del usuario.
phone	phone		string	Número de teléfono del usuario.
mobile	mobile		string	Número de móvil del usuario.
departamento	department		string	Departamento del usuario.
Org	org		string	Organización a la que pertenece el usuario.
addressline1	addressline1		string	Primera línea de la dirección.
addressline2	addressline2		string	Segunda línea de la dirección.
addressline3	addressline3		string	Tercera línea de la dirección.
city	city		string	Ciudad de la dirección.
estado	state		string	Estado de la dirección.
country	country		string	País de la dirección.
Cp	postcode		string	Código postal de la dirección.
addressid	addressid		string	Identificador único de la dirección.
addressline1	addressline1		string	Primera línea de la dirección.
addressline2	addressline2		string	Segunda línea de la dirección.
addressline3	addressline3		string	Tercera línea de la dirección.
city	city		string	Ciudad de la dirección.
estado	state		string	Estado de la dirección.
country	country		string	País de la dirección.
Cp	postCode		string	Código postal de la dirección.
knownas	knownas		string	Nombre o alias alternativos para la dirección.
experiencia	experience		array of string
id	id		string	Id. de vínculo
nombre	name		string	Nombre del vínculo.
value	value		string	Valor de vínculo.
id	id		string	Id. de vínculo
nombre	name		string	Nombre del vínculo.
value	value		string	Valor de vínculo.
id	id		string	Id. de vínculo
nombre	name		string	Nombre del vínculo.
value	value		string	Valor de vínculo.
img	img		string
reportsto	reportsto		string
metadataname	metadataname		array of string
metadatavalue	metadatavalue		array of string
group	group		array of string
externalid	externalid		string	Id. externo del usuario.
jobtitle	jobtitle		string	Título del trabajo del usuario.
secretaryname	secretaryname		string	Nombre del secretario del usuario.
secretarymail	secretarymail		string	Correo electrónico del secretario del usuario.
Especialidades	specialities		string	Especialidades del usuario.
title	title		string	Título del usuario.
goesby	goesby		string	nombre preferido del usuario.
sufijo	suffix		string	Sufijo del nombre del usuario.
atomlink	atomlink		string	Vínculo de Atom asociado al usuario.
bio	bio		string	Biografía del usuario.
dateOfBirth	dateOfBirth		string	Fecha de nacimiento del usuario.
link	link		string	Vínculo asociado al usuario.
estado	status		string	Estado del usuario.
statuscode	statuscode		string	Código de estado del usuario.
Mensaje	message		string	Mensaje asociado al usuario.
sourcetype	sourcetype		string	Tipo de origen del usuario.
orgid	orgid		string	Id. de organización.
ifpartner	ifpartner		string	Marca de asociado.
emaildomain	emaildomain		string	Dominio de correo electrónico del usuario.
invitationsent	invitationsent		string	Marca de invitación enviada.
creadopor	createdby		string	Usuario que creó el registro.
createddate	createddate		string	Fecha en que se creó el registro.
modificadopor	modifiedby		string	Usuario que modificó el registro.
modifieddate	modifieddate		string	Fecha en que se modificó el registro.
lastlogindate	lastlogindate		string	Fecha del último inicio de sesión.
invalidlogins	invalidlogins		string	Recuento de intentos de inicio de sesión no válidos.
publicwebsiteprofileid	publicwebsiteprofileid		string	Id. de perfil del sitio web público.
resetpassworddate	resetpassworddate		string	Fecha de restablecimiento de la contraseña.
avatar	avatar		string	Dirección URL de la imagen de Avatar.
followingcount	followingcount		integer	Recuento de usuarios que se siguen.
followercount	followercount		integer	Recuento de seguidores.
siguiente	following		boolean	Marca siguiente.
role	role		string	Rol del usuario.
isbasicuser	isbasicuser		string	Marca de usuario básica.
encryptedUserId	encryptedUserId		string	Identificador de usuario cifrado.
autoregistro	selfregistered		integer	Marca autoinscriba.
registeredWith2FA	registeredWith2FA		string	Marca de registro de autenticación en dos fases.
isInternal	isInternal		integer	Marca de usuario interna.
orgName	orgName		string	Nombre de la organización.

Devoluciones

Body: IntegrationUserDBO

Archivar usuario

Id. de la operación:: deleteUser

Esta llamada API se usa para archivar un usuario dentro del sistema.

Códigos de error

Resumen	Código ref (antes de V4)	Código ref (V4)
Los siguientes usuarios no existen en el sistema	110	110
Se requiere un identificador de usuario	109	109
El identificador de usuario no tiene el formato adecuado	113	113
La longitud del identificador del usuario no puede superar los 50 caracteres.	N/A	304

JiRA Ticket : https://dev.highq.com/jira/browse/COL-67441

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	versión de api
ID de usuario	userid	True	string	id. de usuario

Carga de un archivo

Id. de la operación:: insertDocument

Esta llamada API carga un archivo en una carpeta especificada en la plataforma HighQ Collaborate. Admite cargas fragmentadas cuando se proporciona el encabezado Content-Range.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Especifica la versión de la API que se está usando.
Archivo que se va a cargar	file	True	file	Especifica el archivo que se va a cargar.
Id. de carpeta principal	parentfolderid	True	string	Especifica el identificador único de la carpeta primaria donde se cargará el archivo.
Invalidar marca duplicada	overrideduplicate		boolean	Indica si se deben invalidar las cargas de archivos duplicadas.
Nombre del documento	filename	True	string	Especifica el nombre del documento.
Nota de versión	versionnote		string	Proporciona una nota que describe la versión del archivo.
Clave de operación progresiva	progressiveoperkey		string	Especifica la clave usada para las operaciones progresivas durante la carga de archivos.
Nombre de la base de datos DMS	dmsdatabasename		string	Especifica el nombre de la base de datos del sistema de administración de documentos.
Fecha de edición de DMS	dmseditdate		string	Especifica la fecha de edición registrada en el sistema de administración de documentos.
Id. de carpeta primaria de DMS	dmsparentfolderid		string	Especifica el identificador único de la carpeta primaria en el sistema de administración de documentos.
Id. de documento de DMS	dmsdocid		string	Especifica el identificador único del documento en el sistema de administración de documentos.
Versión del documento DMS	dmsversion		string	Especifica la versión del documento registrado en el sistema de administración de documentos.
Detalles de notificación	notification		string	Proporciona detalles sobre las notificaciones que se enviarán tras la carga de archivos.
Id. de Batch	batchid		string	Especifica el identificador único de la operación por lotes.
Id. de carpeta raíz	rootfolderid		string	Especifica el identificador único de la carpeta raíz.

Crear carpeta

Id. de la operación:: addFolder

Esta API crea una nueva carpeta dentro del sitio especificado. Permite proporcionar detalles de carpeta y garantiza que la carpeta se crea en la carpeta primaria especificada.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Especifica la versión de la API.
Identificador de lote	batchid		string	Identificador único para la operación por lotes.
Id. de carpeta raíz	rootfolderid		string	Identificador único de la carpeta raíz.
Id. de carpeta principal	parentfolderid	True	string	Identificador único de la carpeta primaria donde se creará la nueva carpeta.
Permitir carpeta duplicada	allowduplicatefolder		boolean	Indica si se permiten carpetas duplicadas en la carpeta primaria especificada.
nombre	name	True	string	Nombre de la carpeta.
descripción	description		string	Descripción de la carpeta.
accessInherited	accessInherited		integer	Indica si se hereda el acceso a carpetas.
batchID	batchID		string	Identificador de lote de la operación.
dmsfolderid	dmsfolderid		string	Identificador de carpeta DMS.
dmsParentFolderID	dmsParentFolderID		string	Identificador de carpeta principal de DMS.
dmscreateddate	dmscreateddate		date-time	Fecha en que se creó la carpeta DMS.
dmsmodifiedBy	dmsmodifiedBy		string	Usuario que modificó por última vez la carpeta DMS.
dmsdatabasename	dmsdatabasename		string	Nombre de la base de datos DMS.
dmslink	dmslink		boolean	Indica si hay un vínculo DMS disponible.
dmslinkby	dmslinkby		string	Usuario que vinculó la carpeta DMS.
emailmetadata	emailmetadata		string	Metadatos de correo electrónico asociados a la carpeta .

Devoluciones

Body: FolderDBOV1

Mover documentos

Id. de la operación:: moveDocuments

Esta API mueve varios archivos de una carpeta a otra dentro del mismo sitio.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Especifica la versión de la API.
Id. de carpeta de destino	targetfolder	True	string	Identificador único de la carpeta de destino donde se moverán los archivos.
fileidCSV	fileidCSV		string	Lista separada por comas de identificadores de archivo que se van a mover.

Obtener información de carpeta

Id. de la operación:: getFolderInfo

El método proporciona detalles de carpeta del identificador de carpeta especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	versión de api
Id. de carpeta	folderid	True	string	folderID
Información de estado	statusinfo		boolean	El parámetro statusinfo permite acceder a información adicional sobre la carpeta. La información disponible incluye estado compartido, estado favorito para el usuario que ha iniciado sesión.

Devoluciones

Body: FolderDBOV2

Para crear el elemento de iSheet

Id. de la operación:: insertISheetItems

Esta llamada API se usa para insertar elemento de iSheet. Se pueden admitir varias iSheets.

Para obtener el estado de un elemento de iSheet basado en una clave progresiva, llame a API POST /api/3/progressivekeystatus/{progressive_key}

Por ejemplo, POST /api/{version}/progressivekeystatus/{progressive_key}

Nombre	Tipo	Description
progressive_key	String	Clave para comprobar el estado de la acción.

Respuesta


              
              <progressivekeyresponse>

               \t<items>

                \t\t<item>

                 \t\t\t<itemid>1232</itemid>

                 \t\t\t<status>SUCCESS</status>

                 \t\t\t<statuscode 200>/statuscode<>

                 \t\t\t<message>Record agregado correctamente</message>

                \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<message>Record agregado correctamente</message>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Versión de la API
Identificador de iSheet	isheetid	True	integer	Identificador de iSheet
Identificador de vista de hoja	sheetviewid		integer	Identificador de la vista iSheet (opcional)
id	id		integer	Identificador de Isheet.
title	title		string	Título de la hoja.
descripción	description		string	Descripción de la hoja.
estado	status		string	Estado de la hoja.
accesstype	accesstype		string	Tipo de acceso de la hoja.
type	type		string	Tipo de la hoja.
viewlink	viewlink		string	Vínculo url para ver la hoja.
allowsections	allowsections		string	Indica si se permiten secciones.
allowlookup	allowlookup		string	Indica si se permite la búsqueda.
displayisheet	displayisheet		string	Mostrar isheet.
searchasdefaultview	searchasdefaultview		string	Establece la búsqueda como vista predeterminada.
enableversion	enableversion		string	Habilitar versión.
enablesheetalerter	enablesheetalerter		string	Activa el alertador de hoja.
alertercondition	alertercondition		string	Condición para desencadenar alertas.
overrideitemmodifieddate	overrideitemmodifieddate		string	Sobre la fecha de modificación del elemento.
enablebulkinsertupdate	enablebulkinsertupdate		string	Permitir la actualización de inserción masiva.
fielddescriptions	fielddescriptions		string	descripción de los campos.
enablerowlocking	enablerowlocking		string	Habilita el bloqueo de filas.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Habilita el truncamiento del límite de caracteres para el texto de varias líneas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	establece el límite de caracteres para el truncamiento.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Permite la reutilización de valores de lista de opciones.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Permite reutilizar los valores de la lista de puntuación.
allowIsheetComments	allowIsheetComments		string	Permite comentarios en la hoja.
shareRecordsLimit	shareRecordsLimit		integer	Límite de registros compartidos.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Habilite el límite de registros de uso compartido.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Habilita el uso compartido del formulario agregar registro.
allowViewBaseRendering	allowViewBaseRendering		string	Permite la representación base de vistas.
columna	column		object
recordcount	recordcount		string	Número total de registros.
viewId	viewId		integer	Identificador único de la vista.
siteId	siteId		integer	Identificador del sitio asociado.
NombreDelSitio	siteName		string	Nombre del sitio.
sheetName	sheetName		string	Nombre de la hoja.
viewName	viewName		string	Nombre de la vista.
sheetId	sheetId		integer	Identificador de la hoja.
secuencia	sequence		string	Número de secuencia de la columna de encabezado.
columnValue	columnValue		string	Valor de la columna de encabezado.
columnTypeId	columnTypeId		string	Identificador del tipo de columna.
columnId	columnId		string	Identificador único de la columna.
columnTypeAlias	columnTypeAlias		string	Nombre de alias para el tipo de columna.
itemsequence	itemsequence		string	Número de secuencia del elemento.
itemid	itemid		string	Identificador único del elemento.
externalid	externalid		string	Identificador externo asociado al elemento.
columnid	columnid		integer	Identificador único de la columna
nombre	name		string	Nombre de la columna
type	type		integer	Tipo de datos de la columna.
systemgeneratedtype	systemgeneratedtype		string	Información de tipo generada por el sistema.
section	section		integer	Número de sección donde se encuentra la columna.
descripción	description		string	Descripción detallada de la columna.
addtodefaultview	addtodefaultview		string	Indica si la columna se agrega a la vista predeterminada.
columnconditionstate	columnconditionstate		string	Estado de la condición de la columna.
rowid	rowid		integer	Identificador de la fila.
columnid	columnid		integer	Identificador de la columna.
operatorid	operatorid		integer	Identificador del operador.
oprand	oprand		string	Valor de operando para el filtro.
logicaltype	logicaltype		string	Tipo lógico del filtro.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	Identificador del tipo de valor de filtro de hoja.
displaytype	displaytype		string	Tipo de presentación del filtro.
sourceColumnId	sourceColumnId		integer	Id. de columna de origen para el filtro.
scoreConditionTypeid	scoreConditionTypeid		integer	Identificador del tipo de condición de puntuación.
defaultvalue	defaultvalue		string	Valor predeterminado de la columna.
columnwidth	columnwidth		string	Ancho de la columna.
sheetname	sheetname		string	Nombre de la hoja asociada.
sitename	sitename		string	Nombre del sitio.
obligatorio	mandatory		string	Indica si la columna es obligatoria.
allowsearch	allowsearch		string	Especifica si se permite la búsqueda.
maxchars	maxchars		integer	Número máximo de caracteres.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Permite el campo de otra hoja.
allowrichhtmltext	allowrichhtmltext		string	Especifica si se permite texto HTML enriquecido.
numberoflines	numberoflines		integer	Número de líneas de la columna.
displaymethod	displaymethod		string	Método usado para mostrar la columna.
includeotheroption	includeotheroption		string	Incluye una opción "Other".
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Especifica el tipo de selección en la búsqueda.
id	id		string	Identificador único de la elección".
label	label		string	Etiqueta para la elección.
puntuación	score		string	Puntuación asociada a la opción.
color	color		string	Código de color para la elección.
imageid	imageid		integer	Id. de la imagen asociada.
includeinalertpreferences	includeinalertpreferences		string	Incluye en las preferencias de alerta.
min	min		string	Valor mínimo de la columna.
max	max		string	Valor máximo de la columna.
decimalplaces	decimalplaces		integer	Número de posiciones decimales.
showthousandseparators	showthousandseparators		string	Muestra miles de separadores.
showaspercentage	showaspercentage		string	Muestra el valor como porcentaje.
formattype	formattype		string	Especifica el tipo de formato de la columna.
dateformat	dateformat		string	Define el formato de fecha de la columna.
defaultdateandtime	defaultdateandtime		string	Establece el valor predeterminado de fecha y hora para la columna.
sheetlookup	sheetlookup		string	Indica si la columna es una búsqueda a otra hoja.
fielddisplay	fielddisplay		string	Determina cómo se muestra el campo.
allowmultipleusers	allowmultipleusers		string	Especifica si varios usuarios pueden acceder al campo.
methodtype	methodtype		string	Define el tipo de método para la columna.
sheetids	sheetids		string	Enumera los identificadores de las hojas asociadas a la columna.
allowuserstorenamelinks	allowuserstorenamelinks		string	Indica si los usuarios pueden cambiar el nombre de los vínculos de la columna.
sheetid	sheetid		integer	Especifica el identificador de la hoja.
columnids	columnids		string	Enumera los identificadores de las columnas.
viewid	viewid		integer	Especifica el identificador de la vista.
allowmultiplevalues	allowmultiplevalues		string	Indica si se permiten varios valores en la columna.
restrictdelete	restrictdelete		string	Especifica si la eliminación está restringida para la columna.
displaycolumnnameprefix	displaycolumnnameprefix		string	Establece el prefijo para mostrar el nombre de columna.
linkname	linkname		string	Define el nombre del vínculo asociado a la columna.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Especifica si los fines de semana se excluyen en el recuento.
currentsheetcolumnid	currentsheetcolumnid		integer	Id. de la columna de hoja actual.
targetsheetcolumnid	targetsheetcolumnid		integer	Identificador de la columna de hoja de destino.
fórmula	formula		string	Especifica la fórmula aplicada a la columna.
startvalue	startvalue		integer	Establece el valor inicial de la columna.
prefix	prefix		string	Define el prefijo para los valores de columna.
Postfix	postfix		string	Define el postfijo para los valores de columna.
minlength	minlength		integer	Especifica la longitud mínima de los valores de columna.
lookupglossarysheetid	lookupglossarysheetid		integer	Especifica el identificador de la hoja del glosario de búsqueda.
lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Especifica el identificador de vista de la hoja del glosario de búsqueda.
Ancho	width		integer	Establece el ancho de la columna.
otherscorevalue	otherscorevalue		string	Define el otro valor de puntuación para la columna.
importdatafromexternalsource	importdatafromexternalsource		string	Indica si los datos se importan desde un origen externo.
analysisengine	analysisengine		string	Especifica el motor de análisis usado para la columna.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Especifica el identificador de carpeta personalizado para los datos adjuntos.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Indica si la carpeta de datos adjuntos está en el sitio actual.
singleLineEmailValidation	singleLineEmailValidation		string	Especifica si se aplica la validación de correo electrónico de una sola línea.
Solo lectura	readonly		string	Indica si la columna es de solo lectura.
virtualColumn	virtualColumn		integer	Especifica si la columna es virtual.
allowInlineEditing	allowInlineEditing		string	Indica si se permite la edición insertada para la columna.
secuencia	sequence		string	Número de secuencia de la columna.
attributecolumnid	attributecolumnid		string	Identificador de columna de atributo.
value	value		string	Valor de los datos sin procesar.
date	date		string	fecha de datos sin procesar.
time	time		string	Hora de los datos sin procesar.
linkdisplayname	linkdisplayname		string	Nombre del vínculo para mostrar.
linkdisplayurl	linkdisplayurl		string	Mostrar vínculo de dirección URL.
id	id		string	Identificador de búsqueda
Correo electrónico	email		string	Dirección de correo electrónico.
userlookuptype	userlookuptype		string	Tipo de búsqueda de usuario.
folderid	folderid		string	Id. de carpeta.
docid	docid		string	Id. de documento.
fromdate	fromdate		string	A partir de la fecha.
todate	todate		string	Hasta la fecha.
archivo	file		string	Contenido del archivo.
nombre	name		string	El nombre de los datos adjuntos.
order	order		string	El orden de los datos adjuntos.
id	id		integer	Identificador único para los datos adjuntos.
extensión	extension		string	Extensión de archivo.
parentfolderid	parentfolderid		integer	Id. de la carpeta primaria.
filehttplink	filehttplink		string	Vínculo HTTP para acceder al archivo.
folderpath	folderpath		string	Ruta de acceso a la carpeta que contiene el archivo.
folderhttplink	folderhttplink		string	Vínculo HTTP a la carpeta.
filesize	filesize		integer	Tamaño del archivo en bytes.
redactionStatus	redactionStatus		boolean	Indica si el archivo está redactado.
displayname	displayname		string	Nombre para mostrar de los datos adjuntos.
siteid	siteid		integer	Id. del sitio asociado a los datos adjuntos.
ID de registro	recordid		string	Id. de registro.
linkname	linkname		string	Nombre del vínculo.
apilink	apilink		string	Vínculo de API.
httplink	httplink		string	Vínculo HTTP.
colViewPosition	colViewPosition		integer	Posición de la columna en la vista.
columntype	columntype		string	Tipo de la columna.
fecha de creación	createdDate		date-time	Fecha y hora en que se creó la columna.
modifiedDate	modifiedDate		date-time	Fecha y hora en que se modificó por última vez la columna.
injectReferenceColumn	injectReferenceColumn		integer	Referencia a una columna insertada
parentColumnID	parentColumnID		integer	Identificador de la columna primaria.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	Id. de columna reutilizado desde una hoja de entrada.
choicelistid	choicelistid		integer	Identificador de la lista de opciones asociada a la columna.
alerteroption	alerteroption		string	Configuración de la opción de alerta para el elemento.
sheettypeid	sheettypeid		integer	Identificador del tipo de hoja.
enableSmartForm	enableSmartForm		string	Activa las características de formulario inteligente.
allowDeletedItemsView	allowDeletedItemsView		string	Permite la visualización de elementos eliminados.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Permite todas las columnas en vistas personalizadas.

Devoluciones

Body: ProgressiveKeyDBO

Recuperar columnas de iSheet

Id. de la operación:: getIsheetColumns

Esta llamada API recupera las columnas asociadas con el iSheet especificado. Esta funcionalidad se admite en la versión 3 y posteriores de la API.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de iSheet	isheetid	True	integer	Especifica el identificador único de iSheet para el que se requieren columnas.
Versión de la API	version	True	string	Especifica la versión de la API que se está usando.
Id. de vista de iSheet	sheetviewid		string	Especifica el identificador de la vista iSheet. Si se omite, se devuelven todas las columnas.
Incluir columnas eliminadas de iSheet	onlyForDeletedIsheet		boolean	Indica si se deben incluir columnas de un iSheet eliminado. El valor predeterminado es false.

Devoluciones

Body: columns

Recuperar información de archivo

Id. de la operación:: getDocumentInfo

Esta llamada API recupera información detallada de un archivo especificado de la plataforma HighQ Collaborate.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Especifica la versión de la API que se está usando.
Id. de archivo	fileid	True	string	Especifica el identificador único del archivo.
Marca de información de DMS más reciente	lastdmsinfo		boolean	Indica si se va a recuperar la información más reciente del sistema de administración de documentos.
Tipo de carpeta	foldertype		string	Especifica el tipo de carpeta si procede.
Incluir información de estado de archivo	statusinfo		boolean	Indica si se debe incluir información adicional de estado de archivo, como el estado compartido, el estado favorito, el recuento de tareas y el estado similar. El valor predeterminado es false.
Incluir metadatos de correo electrónico	emailmetadata		boolean	Indica si se deben incluir metadatos de correo electrónico como remitente, destinatarios y marcas de tiempo. El valor predeterminado es false.

Devoluciones

Body: DocumentDBO

Recuperar lista de usuarios

Id. de la operación:: getAllSystemUsers

Recuperar una lista de usuarios Esta API recupera una lista de usuarios del sistema. Características clave de ## : captura los detalles del usuario con varias opciones de filtrado: admite la paginación con `limit` y `offset` : nuevos parámetros de consulta y campos introducidos en versiones recientes: respuesta estructurada con roles de usuario y atributos ## Nuevos parámetros de consulta (Version-Specific) - Introducidos en V12: : `systemAdminSearch`: cuando se establece `1`en , solo devuelve usuarios con el rol Administrador del sistema. - Introducido en V18: `userid`: acepta valores separados por comas (CSV). Actualizaciones del cuerpo de respuesta ## : nuevos campos agregados: - `emaildomain`, , `orginvitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcode`, `publicprofile`, # `dateOfBirth` Cambio de formato de dirección (de V11): se ha cambiado el `location` nombre de la etiqueta por `address` para la coherencia. - Respuesta de ejemplo: `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>` ## Roles de usuario (introducidos en LA API V11+): respuesta de ejemplo: `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>` ## Límites y desplazamientos - Comportamiento de límite: - Valor predeterminado: `100` si no se proporciona ningún valor. - Use `-1` para devolver todos los registros. - Si el valor es menor que `-1`, el valor predeterminado es `100`. - Comportamiento de desplazamiento: - Valor predeterminado: `0` si no se proporciona ningún valor. - Si el desplazamiento supera el total de registros, el valor predeterminado vuelve a `0`. ## Nuevos roles introducidos: V12: `Basic User`, `Allow user to bypass XSS protection` - V14: `Allow user to manage Contract Express system groups` códigos de error ## | Resumen | Código ref (antes de V4) | Código ref (V4) | |---------|----------------------|--------------| | Entrada no válida para el estado del usuario (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | El identificador de organización no es válido | N/A | 260 | | Valor no válido `neverinvited` (true/false) | N/A | 387 | | Valor no válido `neverlogin` (true/false) | N/A | 388 | | Valor no válido `groupids` | N/A | 214 | | Valor no válido `notingroup` (true/false) | N/A | 389 | | No `ordertype` válido (admitido: nombre, organización, estado, etc.) | N/A | 289 | | No válido `orderby` (compatible: asc, desc) | N/A | 290 | | Valor no válido `offset` | 138 | 138 | | Valor no válido `limit` | 137 | 137 | ## Notas: desde la versión 13 y posteriores, esta API está abierta para todos los usuarios (anteriormente limitados a los administradores del sistema). - A partir de la versión 18, el `userregistered2FA` campo indica si un usuario se ha registrado para 2FA. --- Esta descripción sigue el formato de esquema de Swagger 2.0 y debe colocarse en el campo de descripción del esquema del conector personalizado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Versión de la API.
Estado del usuario	status		string	Filtrar usuarios por estado: Activo, Archivado, Inactivo o Bloqueado.
Desplazamiento de paginación	offset		string	Posición inicial para la paginación.
Límite de resultados	limit		string	Número de elementos que se van a devolver por solicitud.
Id. de organización	orgid		string	Filtre los usuarios por identificador de organización.
Nunca usuarios invitados	neverinvited		string	Recuperar usuarios que nunca se han invitado.
Nunca los usuarios que han iniciado sesión	neverlogin		string	Recuperar usuarios que nunca han iniciado sesión.
Id. de usuario	userid		string	Filtre a los usuarios por sus identificadores de usuario únicos.
Identificador de grupo	groupid		string	Filtrar usuarios por identificadores de grupo.
Usuarios que no están en grupos	notingroup		string	Recuperar usuarios que no están en ningún grupo.
Tipo de criterio de ordenación	ordertype		string	Ordene los usuarios por un campo especificado, como el nombre, la organización o el estado.
Criterio de ordenación	orderby		string	Ordenar da como resultado un orden ascendente o descendente.
Id. externo	externalid		string	Filtre los usuarios por identificador externo.
Nombre	firstname		string	Filtre los usuarios por nombre.
Apellido	lastname		string	Filtre los usuarios por apellidos.
Dirección de correo electrónico	email		string	Filtre los usuarios por dirección de correo electrónico.
Búsqueda de usuarios	search		string	Busque usuarios por varios atributos, incluidos el nombre, el correo electrónico y el título del trabajo.
Filtro de alfabeto	alphabets		string	Filtre los usuarios cuyo apellido comienza con una letra específica.
Título del Puesto	jobtitle		string	Filtre los usuarios por puesto.
Ubicación	locations		string	Filtre los usuarios por ciudad.
Departamento	departments		string	Filtre los usuarios por departamento.
Nombre de la organización	organisations		string	Filtre los usuarios por nombre de la organización.
Especialidades	specialities		string	Filtre a los usuarios por sus especialidades.
Búsqueda del administrador del sistema	systemAdminSearch		string	Recuperar usuarios con el rol Administrador del sistema.

Devoluciones

Body: users

Recuperar una lista de carpetas

Id. de la operación:: getFolderList

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Especifica la versión de la API que se está usando.
Id. de carpeta	folderid	True	string	Especifica el identificador único de la carpeta.
Límite de elementos	limit		string	Especifica el número máximo de elementos que se van a devolver.
Desplazamiento de elementos	offset		string	Especifica la posición inicial de los elementos devueltos.
Dirección del criterio de ordenación	orderby		string	Especifica la dirección del orden de los elementos de ordenación. Use "asc" para el orden ascendente o "desc" para el orden descendente.
Criterio de ordenación	ordertype		string	Especifica el criterio para ordenar elementos, como nombre, autor o fecha de última modificación.
Incluir información de estado de carpeta	statusinfo		boolean	Indica si se debe incluir información adicional sobre el estado de la carpeta. El valor predeterminado es false.
Incluir carpetas inteligentes	includesmartfolder		boolean	Indica si se deben incluir carpetas inteligentes en la lista devuelta. El valor predeterminado es false.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
carpeta	folder	array of object
items	folder	object

Recuperar una lista de elementos de iSheet

Id. de la operación:: getISheetItems

Esta llamada API recupera una lista de elementos contenidos en el iSheet especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Versión de la API	version	True	string	Especifica la versión de la API que se está usando.
Id. de iSheet	isheetid	True	integer	Especifica el identificador único de iSheet.
Id. de vista de iSheet	sheetviewid		integer	Especifica el identificador de la vista iSheet. Si se omite, se devuelve la vista predeterminada.
Ordenar identificador de columna	sortcolumnid		integer	Especifica el identificador de la columna utilizada para ordenar los resultados.
Criterio de ordenación	sortorder		integer	Especifica el criterio de ordenación. Por ejemplo, use 0 para el orden ascendente u otro valor para el orden descendente.
Límite de registros	limit		integer	Especifica el número máximo de registros que se van a devolver; el valor predeterminado es 100 si no se especifica.
Desplazamiento del registro	offset		integer	Especifica la posición inicial para la recuperación de registros; El valor predeterminado es 0 si no se especifica.
Incluir todas las columnas	allColumnRequired		boolean	Marca que indica si se deben incluir todos los datos de columna independientemente de la vista actual.
Omitir restricciones de vista	isIgnoreView		boolean	Marca que indica si se omiten las restricciones de vista al recuperar datos de elementos.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
isheet	isheet	array of object	Lista de elementos de iSheet.
idDeArtículo	isheet.itemId	string	Identificador único del elemento.
datos	isheet.data	array of object	Datos detallados del elemento.
secuencia	isheet.data.sequence	string	Número de secuencia asociado a los datos.
columnDisplayName	isheet.data.columnDisplayName	string	Nombre para mostrar de la columna.
value	isheet.data.value	string	Valor contenido en la columna.

Definiciones

ErrorDBO

Nombre	Ruta de acceso	Tipo
summary	summary	string
ref	ref	string
link	link	string

DocumentDBO

Nombre	Ruta de acceso	Tipo	Description
docid	docid	string	Id. de documento.

columns

Nombre	Ruta de acceso	Tipo	Description
columna	column	array of object
items	column	object

LocationDBO

Nombre	Ruta de acceso	Tipo	Description
addressline1	addressline1	string	Primera línea de la dirección.
addressline2	addressline2	string	Segunda línea de la dirección.
addressline3	addressline3	string	Tercera línea de la dirección.
city	city	string	Ciudad de la dirección.
estado	state	string	Estado de la dirección.
country	country	string	País de la dirección.
Cp	postcode	string	Código postal de la dirección.

Nombre de usuario

Nombre	Ruta de acceso	Tipo	Description
title	title	string	Título del usuario.
nombre de pila	firstname	string	Nombre del usuario.
apellido	lastname	string	Apellidos del usuario.
goesby	goesby	string	nombre preferido del usuario.

MetadataListDBO

Nombre	Ruta de acceso	Tipo	Description
metadataname	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

Nombre	Ruta de acceso	Tipo	Description
id	id	string	Id. de vínculo
nombre	name	string	Nombre del vínculo.
value	value	string	Valor de vínculo.

Link

Nombre	Ruta de acceso	Tipo	Description
link	link	array of NameValueLink

ExperienciasDBO

Nombre	Ruta de acceso	Tipo	Description
experiencia	experience	array of string

GroupsDBO

Nombre	Ruta de acceso	Tipo	Description
group	group	array of string

user

Nombre	Ruta de acceso	Tipo	Description
userid	userid	integer	Id. de usuario
siguiente	following	boolean	Siguiente.
Correo electrónico	email	string	Dirección de correo electrónico.
nombre	name	UserName
userlink	userlink	string	Vínculo de usuario.
httplink	httplink	string	Vínculo HTTP.
httpavatar	httpavatar	string	Avatar HTTP.
avatar	avatar	integer	Avatar del usuario.
externalid	externalid	string	Id. externo.
dateofbirth	dateofbirth	string	Fecha de nacimiento.
phone	phone	string	Número de teléfono.
jobtitle	jobtitle	string	Puesto.
mobile	mobile	string	Número de móvil.
departamento	department	string	Deparment.
estado	status	string	Estado.
Org	org	string	Organización.
orgName	orgName	string	Nombre de la organización.
location	location	LocationDBO
img	img	string	Imagen.
Experiencias	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
customlink	customlink	Link
messaginglink	messaginglink	Link
secretaryname	secretaryname	string	Nombre del secretario.
secretarymail	secretarymail	string	Correo del Secretario.
bio	bio	string	Biografía del usuario.
sourcetype	sourcetype	string	Tipo de origen.
Especialidades	specialities	string	Especialidades.
reportsto	reportsto	string	Usuario al que informa el usuario actual.
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
sufijo	suffix	string	Sufijo del nombre del usuario.
atomlink	atomlink	string	Vínculo de Atom asociado al usuario.
link	link	string	Vínculo asociado al usuario.
loggeduserlike	loggeduserlike	integer	Recuento de likes del usuario que ha iniciado sesión.
nombre de usuario	userName	string	Nombre de usuario.

users

Nombre	Ruta de acceso	Tipo	Description
user	user	array of user

FolderDBOV1

Nombre	Ruta de acceso	Tipo	Description
folderid	folderid	string	Identificador único de la carpeta creada.

DmsDBO

Nombre	Ruta de acceso	Tipo	Description
dmsfolderid	dmsfolderid	string	Identificador de carpeta DMS.
dmsParentFolderID	dmsParentFolderID	string	Identificador de carpeta principal de DMS.
dmscreateddate	dmscreateddate	date-time	Fecha en que se creó la carpeta DMS.
dmsmodifiedBy	dmsmodifiedBy	string	Usuario que modificó por última vez la carpeta DMS.
dmsdatabasename	dmsdatabasename	string	Nombre de la base de datos DMS.
dmslink	dmslink	boolean	Indica si hay un vínculo DMS disponible.
dmslinkby	dmslinkby	string	Usuario que vinculó la carpeta DMS.

grupo de sitios

Nombre	Ruta de acceso	Tipo
nombre	name	string
id	id	integer
copypermissionsfrom	copypermissionsfrom	string
Mensaje	message	string
typeID	typeID	integer
type	type	string
numberofusers	numberofusers	string
creado	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
descripción	description	string
basicusergroup	basicusergroup	integer

Dirección

Nombre	Ruta de acceso	Tipo	Description
addressid	addressid	string	Identificador único de la dirección.
addressline1	addressline1	string	Primera línea de la dirección.
addressline2	addressline2	string	Segunda línea de la dirección.
addressline3	addressline3	string	Tercera línea de la dirección.
city	city	string	Ciudad de la dirección.
estado	state	string	Estado de la dirección.
country	country	string	País de la dirección.
Cp	postCode	string	Código postal de la dirección.
knownas	knownas	string	Nombre o alias alternativos para la dirección.

IntegrationUserDBO

Nombre	Ruta de acceso	Tipo	Description
index	index	integer	Índice único para el usuario.
userid	userid	integer	Identificador único para el usuario.
nombre de pila	firstname	string	Nombre del usuario.
apellido	lastname	string	Apellidos del usuario.
practicegroup	practicegroup	string	Grupo de práctica al que pertenece el usuario.
langcode	langcode	string	Código de idioma del usuario.
localeID	localeID	string	Identificador de configuración regional del usuario.
publicprofile	publicprofile	string	Perfil público del usuario.
pwpid	pwpid	string	Id. de PWP del usuario.
usertypeid	usertypeid	string	Identificador de tipo de usuario.
systemuser	systemuser	string	Marca de usuario del sistema.
Correo electrónico	email	string	Email dirección del usuario.
phone	phone	string	Número de teléfono del usuario.
mobile	mobile	string	Número de móvil del usuario.
departamento	department	string	Departamento del usuario.
Org	org	string	Organización a la que pertenece el usuario.
location	location	LocationDBO
address	address	Address
Experiencias	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
messaginglink	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	Id. externo del usuario.
jobtitle	jobtitle	string	Título del trabajo del usuario.
secretaryname	secretaryname	string	Nombre del secretario del usuario.
secretarymail	secretarymail	string	Correo electrónico del secretario del usuario.
Especialidades	specialities	string	Especialidades del usuario.
title	title	string	Título del usuario.
goesby	goesby	string	nombre preferido del usuario.
sufijo	suffix	string	Sufijo del nombre del usuario.
atomlink	atomlink	string	Vínculo de Atom asociado al usuario.
bio	bio	string	Biografía del usuario.
dateOfBirth	dateOfBirth	string	Fecha de nacimiento del usuario.
link	link	string	Vínculo asociado al usuario.
estado	status	string	Estado del usuario.
statuscode	statuscode	string	Código de estado del usuario.
Mensaje	message	string	Mensaje asociado al usuario.
sourcetype	sourcetype	string	Tipo de origen del usuario.
orgid	orgid	string	Id. de organización.
ifpartner	ifpartner	string	Marca de asociado.
emaildomain	emaildomain	string	Dominio de correo electrónico del usuario.
invitationsent	invitationsent	string	Marca de invitación enviada.
creadopor	createdby	string	Usuario que creó el registro.
createddate	createddate	string	Fecha en que se creó el registro.
modificadopor	modifiedby	string	Usuario que modificó el registro.
modifieddate	modifieddate	string	Fecha en que se modificó el registro.
lastlogindate	lastlogindate	string	Fecha del último inicio de sesión.
invalidlogins	invalidlogins	string	Recuento de intentos de inicio de sesión no válidos.
publicwebsiteprofileid	publicwebsiteprofileid	string	Id. de perfil del sitio web público.
resetpassworddate	resetpassworddate	string	Fecha de restablecimiento de la contraseña.
avatar	avatar	string	Dirección URL de la imagen de Avatar.
followingcount	followingcount	integer	Recuento de usuarios que se siguen.
followercount	followercount	integer	Recuento de seguidores.
siguiente	following	boolean	Marca siguiente.
role	role	string	Rol del usuario.
isbasicuser	isbasicuser	string	Marca de usuario básica.
encryptedUserId	encryptedUserId	string	Identificador de usuario cifrado.
autoregistro	selfregistered	integer	Marca autoinscriba.
registeredWith2FA	registeredWith2FA	string	Marca de registro de autenticación en dos fases.
isInternal	isInternal	integer	Marca de usuario interna.
orgName	orgName	string	Nombre de la organización.

sitio web

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador del sitio.
sitename	sitename	string	El nombre del sitio.
role	role	string	Rol del sitio.
sitedescription	sitedescription	string	Descripción del sitio.
enabledmodules	enabledmodules	string	Lista de módulos habilitados para el sitio.
sitefolderID	sitefolderID	string	Identificador de la carpeta del sitio.
sitefolderpermission	sitefolderpermission	string	Nivel de permiso para la carpeta del sitio.
módulo	module	ModuleDBO
adminnote	adminnote	string	Notas administrativas relacionadas con el sitio.
startdate	startdate	string	Fecha de inicio de la operación del sitio.
enddate	enddate	string	Fecha de finalización de la operación del sitio.
createddate	createddate	string	Fecha en que se creó el sitio.
archiveddate	archiveddate	string	Fecha en la que se ha archivado el sitio.
clientno	clientno	string	Número de cliente asociado al sitio.
matterno	matterno	string	Número de asunto asociado al sitio.
página de aterrizaje	landingpage	string	Dirección URL de la página de aterrizaje del sitio.
link	link	string	Vínculo relacionado con el sitio.
estado	status	string	Estado actual del sitio.
statusid	statusid	integer	Identificador del estado del sitio.
size	size	string	Tamaño del sitio.
billingnotes	billingnotes	string	Notas relacionadas con la facturación del sitio.
billingnextinvoicedate	billingnextinvoicedate	string	Fecha de la siguiente factura del sitio.
billinglastinvoicedate	billinglastinvoicedate	string	Fecha de la última factura del sitio.
filepagecount	filepagecount	string	Recuento total de páginas de archivos en el sitio.
maxpagecount	maxpagecount	string	Número máximo permitido de páginas para archivos en el sitio.
sitehttplink	sitehttplink	string	Vínculo HTTP al sitio.
isSyncable	isSyncable	integer	Indica si el sitio es sincronizable.
enforceusergroups	enforceusergroups	string	Los grupos de usuarios aplicados para el sitio.
csvSiteCategory	csvSiteCategory	string	Categoría del sitio en formato CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	Nombre del sitio en el idioma predeterminado.
visible	visible	integer	Indica si el sitio está visible.
siteLogoName	siteLogoName	string	Nombre del archivo de logotipo del sitio.
siteLogoFileSize	siteLogoFileSize	integer	Tamaño del archivo del logotipo del sitio.
siteLogoHeight	siteLogoHeight	integer	Alto del logotipo del sitio.
siteLogoWidth	siteLogoWidth	integer	Ancho del logotipo del sitio.
siteStatus	siteStatus	integer	Código de estado del sitio.
applySiteTerms	applySiteTerms	integer	Indica si se aplican los términos del sitio.
siteTerm	siteTerm	string	Los términos aplicados al sitio.
termType	termType	integer	Tipo de términos aplicados al sitio.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Indica si los términos del sitio son necesarios en el siguiente inicio de sesión.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Indica si los términos de sitio predeterminados están habilitados.
advancedQAPermission	advancedQAPermission	integer	Nivel de permiso de control de calidad avanzado para el sitio.
isInternal	isInternal	integer	Indica si el sitio es interno.
Psm	psm	integer	Identificador de Product Service Manager.
siteLabelDisplay	siteLabelDisplay	string	Etiqueta para mostrar del sitio.
allowSiteAdministration	allowSiteAdministration	integer	Indica si se permite la administración del sitio.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	Para habilitar la protección con contraseña de nivel de sitio.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	Para habilitar la protección de código de acceso de nivel de sitio.
passcodeUsingAuthApp	passcodeUsingAuthApp	integer	Indica si la autenticación de código de acceso usa una aplicación de autenticación.
sitePassword	sitePassword	string	Contraseña asociada al sitio.
ipRestrictionEnable	ipRestrictionEnable	integer	Para habilitar las restricciones de IP para el acceso al sitio.
availableIP	availableIP	string	Lista separada por comas de direcciones IP permitidas para acceder al sitio.
highqDrive	highqDrive	integer	Indica si la integración de HighQ Drive está habilitada.
applySiteHomePage	applySiteHomePage	integer	Para aplicar una página principal personalizada para el sitio.
siteHomePage	siteHomePage	string	Dirección URL de la página principal personalizada del sitio.
siteHomePageType	siteHomePageType	integer	Tipo de la página principal.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	Para establecer el siguiente inicio de sesión en la página principal del sitio.
applyDisplayContent	applyDisplayContent	integer	Para aplicar la configuración de contenido para mostrar.
displayContent	displayContent	string	Contenido que se va a mostrar en el sitio.
rssSecurity	rssSecurity	integer	Nivel de seguridad de fuente RSS.
encryptedPassword	encryptedPassword	integer	Indica si la contraseña del sitio está cifrada.
availableIPRangeCSV	availableIPRangeCSV	string	Lista separada por comas de intervalos de direcciones IP permitidos para acceder al sitio.
siteModuleID	siteModuleID	integer	Identificador del módulo de sitio.
icalSecurity	icalSecurity	integer	Nivel de seguridad de fuente iCal.
defaultDisplayContent	defaultDisplayContent	string	Contenido predeterminado que se va a mostrar en el sitio.
defaultEmailAlert	defaultEmailAlert	integer	Para habilitar las alertas de correo electrónico predeterminadas.
excelReportFooter	excelReportFooter	integer	Incluye un pie de página en informes de Excel.
excelReportFooterText	excelReportFooterText	string	Texto que se va a mostrar en el pie de página de los informes de Excel.
announcementMLJSON	announcementMLJSON	string	Anuncios con formato JSON para el sitio.
templateType	templateType	integer	Tipo de plantilla usada para el sitio.
templateLicence	templateLicence	integer	Tipo de licencia para la plantilla de sitio.
openChannelAppID	openChannelAppID	string	Identificador de aplicación para la integración del canal abierto.
itemid	itemid	integer	Identificador del elemento asociado al sitio.
sitemetadatasheetid	sitemetadatasheetid	integer	Id. de la hoja de metadatos asociada al sitio.
mysite	mysite	boolean	Indica si se trata del sitio personal del usuario.
lastaccesseddate	lastaccesseddate	string	Fecha y hora en que se accedió por última vez al sitio.
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Pestaña metadatos predeterminados para el visor del sitio.
documentMetadataViewId	documentMetadataViewId	integer	metadatos de documento para el identificador de vista.
folderMetadataViewId	folderMetadataViewId	integer	metadatos de carpeta para el identificador de vista.
docSort	docSort	integer	Criterio de ordenación de documentos.
folderSort	folderSort	integer	Criterio de ordenación de carpetas.
defaultFolderRenderView	defaultFolderRenderView	integer	Determina el modo de vista predeterminado para las carpetas.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	Ubicación predeterminada para los datos adjuntos de la tarea.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	Identificador único de la carpeta designada como ubicación predeterminada para los datos adjuntos de la tarea.
favorito	favourite	string	estado favorito.
enabledocumentredaction	enabledocumentredaction	boolean	Especifica si la reacción de documentos está habilitada para el sitio.
mentiongroups	mentiongroups	integer	Los grupos mencionados.
enablefilerelationships	enablefilerelationships	boolean	Indica si las relaciones de archivo están habilitadas.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	Nivel de permiso necesario para administrar las relaciones de archivo.

ModuleDBO

Nombre	Ruta de acceso	Tipo
hogar	home	HomeDBO
actividad	activity	ActivityDBO
documento	document	DocumentDBO
blog	blog	BlogDBO
wiki	wiki	WikiDBO
task	task	TaskDBO
evento	event	EventDBO
isheet	isheet	ISheetDBO
Qa	qa	QaDBO
people	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Nombre	Ruta de acceso	Tipo	Description
habilitar	enable	string	Habilite el estado de HomeDBO.

ActivityDBO

Nombre	Ruta de acceso	Tipo	Description
habilitar	enable	string	Habilite el estado de ActivityDBO.
microblog	microblog	string	Contenido de Microblog asociado a ActivityDBO.

BlogDBO

Nombre	Ruta de acceso	Tipo	Description
blogTitle	blogTitle	string	Título de la entrada de blog.
blogContent	blogContent	string	Contenido de la entrada de blog.
showComment	showComment	integer	mostrar el comentario.
tagList	tagList	array of string	Lista de etiquetas asociadas al blog.
estado	status	integer	estado de la entrada de blog.
siteID	siteID	integer	Identificador del sitio asociado.
autor	author	string	Autor del blog.
categoryList	categoryList	array of string	Categorías asignadas a la entrada de blog.
notificationTypeID	notificationTypeID	integer	Identificador del tipo de notificación.
Mensaje	message	string	Contenido del mensaje relacionado con el blog.
messageCode	messageCode	integer	Código asociado al mensaje.
externalId	externalID	string	Identificador externo vinculado al blog.
publishDate	publishDate	string	Fecha de publicación del blog.
processtype	processtype	string	Tipo de proceso asociado al blog.
habilitar	enable	string	Habilite el estado de BlogDBO.

WikiDBO

Nombre	Ruta de acceso	Tipo	Description
wikiid	wikiid	integer	Identificador único de la wiki.
currentversionid	currentversionid	integer	Identificador de la versión actual de la wiki
parentwikiid	parentwikiid	integer	Identificador de la wiki primaria.
wikititle	wikititle	string	Título de la wiki.
wikicontent	wikicontent	string	Contenido de la wiki.
showcomment	showcomment	integer	Indica si los comentarios están habilitados.
createddate	createddate	string	Fecha de creación de la wiki.
modifieddate	modifieddate	string	Fecha de última modificación de la wiki.
taglist	taglist	string	Lista separada por comas de etiquetas asociadas a la wiki.
wikipath	wikipath	string	Ruta de acceso para acceder a la wiki.
wikidraftid	wikidraftid	integer	Identificador de la versión de borrador de la wiki.
drafttype	drafttype	string	Tipo de borrador asociado a la wiki.
estado	status	integer	Estado actual de la wiki.
wikiversionid	wikiversionid	integer	Identificador de versión de la wiki.

TaskDBO

Nombre	Ruta de acceso	Tipo	Description
index	index	string	Índice o identificador de la tarea.
parenttaskid	parenttaskid	integer	Identificador de la tarea primaria.
taskid	taskid	integer	Identificador único de la tarea.
title	title	string	Título de la tarea.
descripción	description	string	Descripción detallada de la tarea.
duedate	duedate	string	Fecha de vencimiento para la finalización de la tarea.
startdate	startdate	string	Fecha de inicio en la que se inició la tarea.
mattermaptaskid	mattermaptaskid	string	Identificador que vincula a la tarea de asignación de materia.
type	type	string	Tipo o categoría de la tarea.
dependenton	dependenton	string	Tareas de las que depende esta tarea.
daysfromdependent	daysfromdependent	string	Número de días de la tarea dependiente.
ignoreweekend	ignoreweekend	integer	Indica si los fines de semana se omiten en la programación.
duration	duration	integer	Duración para completar la tarea.
resource	resource	string	Recursos asignados a la tarea.

EventDBO

Nombre	Ruta de acceso	Tipo	Description
eventTitle	eventTitle	string	Título del evento.
eventContent	eventContent	string	Contenido del evento.
showComment	showComment	integer	Indica si los comentarios están habilitados para el evento.
tagList	tagList	array of string	Lista de etiquetas asociadas al evento.
estado	status	integer	Estado actual del evento.
siteID	siteID	integer	Identificador del sitio.
contacto	contact	string	Información de contacto del evento.
categoryList	categoryList	array of string	Categorías en las que se muestra el evento.
notificationTypeID	notificationTypeID	integer	Tipo de notificación relacionado con el evento.
Mensaje	message	string	Mensaje del evento.
messageCode	messageCode	integer	Código de mensaje del evento.
externalId	externalID	string	Identificador externo.
startDate	startDate	string	Fecha de inicio del evento.
fecha de finalización	endDate	string	Fecha de finalización del evento.
startTime	startTime	string	Hora de inicio del evento.
endTime	endTime	string	Hora de finalización del evento.
location	location	string	Ubicación del evento.
autor	author	string	Autor del evento.
processtype	processtype	string	Tiempo de proceso del evento.
habilitar	enable	string	Habilite el evento.

ISheetDBO

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador único de iSheet.
title	title	string	Título de iSheet.
descripción	description	string	Descripción de la hoja isheet.
estado	status	string	Estado de la hoja isheet.
accesstype	accesstype	string	Tipo de acceso de la hoja isheet.
type	type	string	Tipo de la hoja isheet.
viewlink	viewlink	string	Vínculo para ver iSheet.
allowsections	allowsections	string	Indica si se permiten secciones.
allowlookup	allowlookup	string	Si los campos de búsqueda están habilitados.
displayisheet	displayisheet	string	Mostrar las opciones de iSheet.
searchasdefaultview	searchasdefaultview	string	Indica si la búsqueda es la vista predeterminada.
enableversion	enableversion	string	Marca habilitada para control de versiones.
enablesheetalerter	enablesheetalerter	string	Marca para habilitar las alertas de hoja.
alertercondition	alertercondition	string	Condiciones para desencadenar alertas.
overrideitemmodifieddate	overrideitemmodifieddate	string	Invalide la marca de fecha modificada.
enablebulkinsertupdate	enablebulkinsertupdate	string	Habilite la inserción o actualización masiva.
fielddescriptions	fielddescriptions	string	Descripciones de campo para iSheet.
enablerowlocking	enablerowlocking	string	Habilite el bloqueo de nivel de fila.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Truncar la marca de texto de varias líneas.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Límite de caracteres para el truncamiento de varias líneas.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Permitir la reutilización de valores de lista de opciones.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Permitir la reutilización de los valores de la lista de puntuación.
allowIsheetComments	allowIsheetComments	string	Permitir comentarios en iSheet.
shareRecordsLimit	shareRecordsLimit	integer	Límite de registros permitidos para compartir.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Límite de recursos compartidos de registros habilitados.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Habilite el uso compartido de formularios para agregar registros.
recordcount	recordcount	string	Recuento de registros actual.
sheettypeid	sheettypeid	integer	Identificador de tipo de iSheet

QaDBO

Nombre	Ruta de acceso	Tipo	Description
habilitar	enable	string	Habilite la funcionalidad qa.

PeopleDBO

Nombre	Ruta de acceso	Tipo	Description
persona	person	array of PersonDBO

PersonDBO

Nombre	Ruta de acceso	Tipo	Description
userid	userid	integer	Id. de usuario
Correo electrónico	email	string	dirección de correo electrónico.
httpavatar	httpavatar	string	DIRECCIÓN URL HTTP del avatar.
avatar	avatar	string	Imagen de avatar.
userlink	userlink	string	Vínculo al perfil de usuario.
httplink	httplink	string	Vínculo HTTP al perfil de usuario.
phone	phone	string	Número de teléfono.
mobile	mobile	string	Número de móvil.
departamento	department	string	Departamento del usuario.

ContractExpressDBO

Nombre	Ruta de acceso	Tipo	Description
habilitar	enable	string	Habilite la integración de Contract Express.

FolderDBOV2

Nombre	Ruta de acceso	Tipo	Description
nombre	name	string	Nombre de carpeta.
descripción	description	string	Descripción de la carpeta.
parentFolderID	parentFolderID	integer	Id. de carpeta principal.
accessInherited	accessInherited	integer	Estado de herencia de acceso.
batchID	batchID	string	Identificador de lote
Dms	dms	DmsDBO
id	id	integer	Id. de carpeta.
link	link	string	Vínculo de carpeta.
createddate	createddate	string	Fecha de creación.
modifieddate	modifieddate	string	Fecha de modificación.
secundario	child	integer	Carpetas secundarias.
filecount	filecount	integer	Número de archivos.
creadopor	createdby	UserDBO
modificadopor	modifiedby	UserDBO
folderid	folderid	integer	Id. de carpeta.
dmsfolderid	dmsfolderid	string	Identificador de carpeta DMS.
siteid	siteid	integer	Id. de sitio de
location	location	string	Ubicación de la carpeta.
permiso	permission	PermissionDBO
contentstatus	contentstatus	integer	Estado del contenido.
autonumeración	autonumbering	string	Configuración de numeración automática.
foldersize	foldersize	string	Tamaño de la carpeta.
sharedstatus	sharedstatus	integer	Estado de uso compartido.
favoritestatus	favouritestatus	integer	Estado favorito.
foldertype	foldertype	string	Tipo de carpeta.
idDeArtículo	itemId	integer	Identificador del elemento.
folderMetadataSheetId	folderMetadataSheetId	integer	Metadatos de carpeta del identificador de hoja.

UserDBO

Nombre	Ruta de acceso	Tipo	Description
nombre de pila	firstname	string	Nombre.
apellido	lastname	string	Apellido.
Correo electrónico	email	string	Dirección de correo electrónico.
userid	userid	integer	Id. de usuario

PermissionDBO

Nombre	Ruta de acceso	Tipo	Description
view	view	integer	Ver permiso.
edit	edit	integer	Editar permiso.
delete	delete	integer	Eliminar permiso.
addEditAllFiles	addEditAllFiles	integer	Agregar o editar todos los archivos permiso.
admin	admin	integer	Permiso de administrador.
viewAllFiles	viewAllFiles	integer	Ver todos los archivos Permiso.
disableSave	disableSave	integer	deshabilitar el permiso para guardar.
uploadFile	uploadFile	integer	cargar el permiso de archivo.
updateFile	updateFile	integer	actualizar el permiso del archivo.
deleteFile	deleteFile	integer	Eliminar permiso de archivo.

ProgressiveKeyDBO

Nombre	Ruta de acceso	Tipo	Description
progressivekey	progressivekey	string	Clave para las operaciones progresivas.
siteid	siteid	integer	Identificador del sitio.
progressivekeystatus	progressivekeystatus	string	Estado de la clave progresiva.
userid	userid	integer	Identificador del usuario.
responsebody	responsebody	string	Cuerpo de la respuesta.
Mensaje	message	string	Contenido del mensaje.
messagecode	messagecode	string	Código asociado al mensaje.
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
error	error	ErrorDBO
tipo de contenido	contentType	string	Tipo de contenido.
failedEntities	failedEntities	integer	Número de entidades con errores.
downloadlink	downloadlink	string	Vínculo para descargar contenido.
archivo adjunto	attachment	Attachment
link	link	string	Vínculo asociado.
documentid	documentid	integer	Identificador del documento.
progresskey	progresskey	string	Clave de progreso para el seguimiento.
progresskeystatus	progresskeystatus	string	Estado de la clave de progreso.

IntegrationResponseDBO

Nombre	Ruta de acceso	Tipo	Description
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
failedEntities	failedEntities	integer	Número de entidades que no se pudieron procesar.
successEntities	successEntities	integer	Número de entidades que se procesaron correctamente.

IntegrationResponseUsersObject

Nombre	Ruta de acceso	Tipo	Description
user	user	array of IntegrationUserDBO

ColumnErrorsDBO

Nombre	Ruta de acceso	Tipo	Description
columna	column	array of ColumnErrorDBO
failedEntities	failedEntities	integer	Número de entidades que no se pudieron realizar debido a errores de columna.
successEntities	successEntities	integer	Número de entidades que se procesaron correctamente.

ColumnErrorDBO

Nombre	Ruta de acceso	Tipo	Description
index	index	integer	Posición de índice de la columna con error.
columnid	columnid	integer	Identificador único de la columna con error.
nombre	name	string	Nombre de la columna con error.
estado	status	string	Estado que indica la condición de error.
statuscode	statuscode	string	Código que representa el estado del error.
Mensaje	message	string	Mensaje de error detallado.

ItemErrorsDBO

Nombre	Ruta de acceso	Tipo	Description
item	item	array of ItemErrorDBO
failedEntities	failedEntities	integer	Número de entidades que no se pudieron realizar debido a errores de elemento.
successEntities	successEntities	integer	Número de entidades que se procesaron correctamente a pesar de los errores de elemento.

ItemErrorDBO

Nombre	Ruta de acceso	Tipo	Description
index	index	integer	Posición de índice del elemento con error.
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Identificador único del elemento con error.
externalid	externalid	string	Identificador externo asociado al elemento.
id	id	string	Identificador interno del elemento.
nombre	name	string	Nombre del elemento con error.
estado	status	string	Estado que indica la condición de error.
statuscode	statuscode	string	Código que representa el estado del error.
Mensaje	message	string	Mensaje de error detallado.
successdeletedcount	successdeletedcount	integer	Recuento de entidades eliminadas correctamente.
failurecount	failurecount	integer	Recuento de entidades que no se pudieron procesar.
failedEntities	failedEntities	integer	Número de entidades que no se pudieron realizar debido a errores de elemento.
successEntities	successEntities	integer	Número de entidades que se procesaron correctamente.

importISheetTemplateDBO

Nombre	Ruta de acceso	Tipo	Description
linkedtemplateid	linkedtemplateid	integer	Identificador de la plantilla vinculada.
aliasname	aliasname	string	Nombre de alias de la plantilla.
linkedisheet	linkedisheet	string	Identificador de la hoja de entrada vinculada.
importdata	importdata	string	Datos que se van a importar desde la plantilla.
appendisheetname	appendisheetname	string	Nombre de la hoja a la que se van a anexar datos.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
ID de plantilla	templateId	integer	Identificador de la plantilla.
templateTitle	templateTitle	string	Título de la plantilla.
viewIDs	viewIDs	string	Lista separada por comas de identificadores de vista.

ISheetTemplateParameterGroups

Nombre	Ruta de acceso	Tipo	Description
templateparametergroup	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Nombre	Ruta de acceso	Tipo	Description
templateruleid	templateruleid	integer	Grupo de parámetros de plantilla de Isheet.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Nombre	Ruta de acceso	Tipo	Description
id	id	integer	Identificador del parámetro de plantilla de isheet.
nombre	name	string	Nombre del parámetro de plantilla de isheet.
datos	data	string	datos del parámetro de plantilla de isheet.

Datos adjuntos

Nombre	Ruta de acceso	Tipo	Description
archivo	file	string	Contenido del archivo.
nombre	name	string	El nombre de los datos adjuntos.
order	order	string	El orden de los datos adjuntos.
id	id	integer	Identificador único para los datos adjuntos.
extensión	extension	string	Extensión de archivo.
parentfolderid	parentfolderid	integer	Id. de la carpeta primaria.
filehttplink	filehttplink	string	Vínculo HTTP para acceder al archivo.
folderpath	folderpath	string	Ruta de acceso a la carpeta que contiene el archivo.
folderhttplink	folderhttplink	string	Vínculo HTTP a la carpeta.
filesize	filesize	integer	Tamaño del archivo en bytes.
redactionStatus	redactionStatus	boolean	Indica si el archivo está redactado.
displayname	displayname	string	Nombre para mostrar de los datos adjuntos.
siteid	siteid	integer	Id. del sitio asociado a los datos adjuntos.

Compartir a través de

HighQ (versión preliminar)

HighQ

Información general

Autenticación

Operaciones del conector

Módulo ISheet

API de recursos de documento

API de administración de ISheet

Operaciones de usuario

Administración de documentos y sitios

Introducción

Parámetros y configuración

Solución de problemas y limitaciones

Recursos adicionales

Licencias y soporte técnico

Limitaciones

Acciones

Actualizar grupo de sitios

Parámetros

Devoluciones

Actualizar sitio

Parámetros

Agregar sitio

Parámetros

Devoluciones

Agregar un grupo existente al sitio

Parámetros

Devoluciones

Agregar usuario

Parámetros

Devoluciones

Archivar usuario

Parámetros

Carga de un archivo

Parámetros

Crear carpeta

Parámetros

Devoluciones

Mover documentos

Parámetros

Obtener información de carpeta

Parámetros

Devoluciones

Para crear el elemento de iSheet

Parámetros

Devoluciones

Recuperar columnas de iSheet

Parámetros

Devoluciones

Recuperar información de archivo

Parámetros

Devoluciones

Recuperar lista de usuarios

Parámetros

Devoluciones

Recuperar una lista de carpetas

Parámetros

Devoluciones

Recuperar una lista de elementos de iSheet

Parámetros

Devoluciones

Definiciones

ErrorDBO

DocumentDBO

columns

LocationDBO

Nombre de usuario

MetadataListDBO

NameValueLink

Link

ExperienciasDBO

GroupsDBO

user

users

FolderDBOV1

DmsDBO

grupo de sitios

Dirección

IntegrationUserDBO