Compartir a través de


QPP NextGen (versión preliminar)

Quark Publishing Platform (QPP) NextGen es un sistema de administración de contenido de componentes basado en la nube (CCMS) para automatizar la publicación de contenido empresarial altamente regulado. El conector QPP NextGen ayuda a mover datos del ecosistema de contenido en ambas direcciones para simplificar los procesos y acelerar el tiempo de comercialización.

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 Soporte técnico de Quark
URL https://quarksoftware.my.site.com
Correo Electrónico support_cases@quark.com
Metadatos del conector
Publicador Quark Software Inc.
Sitio web https://www.quark.com/
Directiva de privacidad https://www.quark.com/privacy-policy
Categorías Contenido y archivos; Productividad

Quark Publishing Platform (QPP) NextGen es un sistema de administración de contenido de componentes basado en la nube (CCMS) para automatizar la publicación de contenido empresarial altamente regulado. El conector QPP NextGen ayuda a mover datos del ecosistema de contenido en ambas direcciones para simplificar los procesos y acelerar el tiempo de comercialización.

Prerrequisitos

  • Necesita un entorno de QPP-NG (v3.3 anterior) y QPP-NG licencias para usar nuestro conector.
  • Debe tener un cliente existente (Conexión), preferiblemente independiente, creado en los inquilinos para los que quieren que interactúen las acciones y desencadenadores de este conector. Puede encontrar más detalles en la sección Obtención de credenciales.
  • Comprenda cómo usar Power Automate y obtener valor mediante contenido dinámico o desde otra respuesta de acciones mediante el creador de consultas.

Obtención de credenciales

Al crear una nueva conexión con nuestro conector, verá 3 parámetros. Los detalles para adquirir cada uno se comparten a continuación. Crear y manaEste crear una nueva conexión con nuestro conector, los usuarios verán 3 parámetros. Los detalles para adquirir cada uno se comparten a continuación. El usuario administrador debe crear y administrar QPP-NG conexiones. Consulte con el administrador de entornos de QPP-NG.

También puede asignar un nombre adecuado a sus credenciales para identificarlas fácilmente más adelante. Vaya a Conexiones en Power Automate, busque el nombre del conector y edite una conexión existente y proporcione un nombre adecuado.

  • Id. de cliente: Puede ir a la aplicación administrador de inquilinos de QPP-NG deseada y, a continuación, Establecer > conexiones. Aquí pueden crear una nueva conexión o usar una existente. Solo tiene que escribir el nombre de conexión para Id. de cliente.
  • Secreto de cliente: Al igual que id. de cliente, vaya a Conexiones y escriba Secreto para la conexión existente. Vuelva a generar el secreto si no lo tiene. Los secretos se deben almacenar para las conexiones existentes de forma segura, administradas por el administrador. Consulte con el administrador antes de volver a generar el secreto.
  • Nombre de host: Nombre de host del inquilino de QPP-NG que desea crear conexiones para interactuar con nuestro conector. ejemplo (yourtenantname.app.quark.com). Debe estar visible la dirección URL cuando acceda al entorno de QPP-NG.

Después de crear credenciales, puede probar las credenciales para ver si las credenciales son correctas.

Las acciones simples como getUser se pueden usar desde nuestro conector en un flujo manual, Pruebe el flujo con campos predeterminados.

Al crear una conexión por primera vez, algunos códigos de error que se pueden enfrentar son los siguientes:

  • Dirección URL de host no válida (500): Vuelva a comprobar el nombre de host del entorno de QPP-NG, el identificador de cliente y el secreto deben pertenecer a esta conexión.
  • No autorizado/unauthorized_client (401): Para las credenciales de cliente no válidas o de cliente no válidas, asegúrese de que el identificador de cliente y el secreto de cliente son válidos y pertenecen al nombre de host que se está usando.

Introducción a QPP-NG Integration Hub

Para empezar, puede escuchar una amplia variedad de eventos de Tipo Asset, Collections, etc. del inquilino de QPP-NG mediante el desencadenador integrado.

  • Cree un nuevo flujo de Automatización en Power Automate.
  • Seleccione nuestro conector de QPP-NG y elija un desencadenador.
  • Rellene los campos obligatorios. Consulte la sección Webhook-trigger en la documentación del archivo Léame de GitHub.
  • Seleccione la conexión adecuada para el inquilino de QPP-NG donde desea registrar el webhook. También puede crear nuevas conexiones. Siga los pasos indicados en la sección Obtención de credenciales .
  • Guarde el flujo. Esto ejecutará la solicitud de registro en la parte posterior. Cuando vuelva a la página de detalles del flujo (o haga clic en el botón Atrás), debería ver un subrayado verde en la parte superior que menciona que todo salió bien y el flujo está listo para desencadenarse.
  • Una vez que el flujo se ejecute una vez, puede obtener más información sobre la respuesta del webhook a la ejecución del flujo y usar la respuesta para generar contenido dinámico. Para ello, puede usar la acción analizar json OOTB.
  • En caso de que este sea el primer webhook con este tipo de cambio (evento) registrado en el inquilino de QPP-NG, debe esperar 15 minutos antes de que se active el webhook y, a continuación, puede esperar que se desencadene el flujo.

Si hay errores en el comprobador de flujo con el desencadenador de webhook, Power Automate mostrará rojo en el comprobador de flujo. Ábralo y compruebe el error. A continuación se muestran algunos de los errores que puede encontrar y los pasos para mitigarlos.

  • El webhook con el nombre ya existe Proporcione un nombre único para el webhook o use la operación Eliminar webhook con la misma conexión en otro flujo manual. Seleccione el webhook con el mismo nombre y elimínelo. Puede encontrar más información sobre webhooks en el portal para desarrolladores de Quark.
  • Solicitud incorrecta(400) Compruebe los parámetros proporcionados según la documentación y los detalles del error.
  • No se encontró el recurso (404) y falta el encabezado location en la solicitud de suscripción Elimine el flujo y cree un nuevo desencadenador y flujo de webhook. Si el flujo es grande, duplique el flujo y, al mismo tiempo, habilite el flujo y guarde, Power Automate intentará realizar un registro de webhook nuevo.

Problemas conocidos y limitaciones

  • Actualmente, no podrá actualizar los parámetros de un desencadenador de webhook ya registrado. Como solución alternativa, elimine la operación de webhook actual del flujo y agregue un nuevo desencadenador de webhook QPP-NG en su lugar. Para eliminar el webhook registrado anteriormente del entorno de QPP-NG, cree un nuevo flujo manual con la operación de eliminación, seleccione el webhook anterior en la lista desplegable y ejecute el flujo. Si esta solución alternativa no funciona y el flujo es grande, duplique el flujo y, después de actualizar los detalles del webhook, guárdelo y habilite. Esto también creará un nuevo registro de webhook correctamente.
  • También puede desactivar el flujo antes de eliminar y crear un nuevo desencadenador. Esto también garantizará que el nuevo webhook se registre.
  • Si el servicio de webhook QPP-NG no puede invocar el desencadenador de webhook registrado durante 3 veces, el webhook se deshabilitará.
  • Al guardar determinadas acciones sin parámetros dados (vacíos) se produce un error (se espera algún valor en el cuerpo).
  • Si este es el primer webhook con este tipo de cambio (evento), debe esperar 15 minutos antes de que se active el webhook y, a continuación, puede esperar que se desencadene el flujo.
  • Use la vista del diseñador heredado para obtener la mejor experiencia, ya que puede haber problemas con el nuevo diseñador debido al desarrollo continuo, tales acciones con problemas con el nuevo diseñador son CheckOut, SetAttributeValues , InitNewCheckin y CreateQuery.

Errores y soluciones comunes

  • Al registrar el desencadenador de webhooks como primer paso, puede haber un problema en el registro con nuestro servicio si los detalles no se proporcionan correctamente. Esto se puede restringir después de guardar el flujo con el desencadenador y volver a la ventana de la página Detalles del flujo donde se muestran las últimas 28 ejecuciones de días. Si muestra rojo, significa que el webhook no se ha registrado correctamente. Compruebe el error. Si el error se produce debido a que falta el encabezado Location o no se encuentra el recurso, intente eliminar y crear el desencadenador de nuevo.
  • Si los flujos no se desencadenan, puede deberse a un webhook existente registrado como punto de conexión que no existe, como un flujo eliminado, etc. En tal situación, ejecute api https://{Host.name}/webhooks/api/v3/registrations con el token de API para obtener una lista de todos los webhooks registrados en el entorno de QPP-NG y use esta respuesta para quitar dichos webhooks mediante la acción eliminar webhooks. También debe asegurarse de que el servicio webhooks esté configurado y ejecutándose correctamente desde la compatibilidad con Quark mediante (https://quarksoftware.my.site.com).
  • Si no recibe un usuario con privilegios ni ningún error de autenticación, compruebe que el nombre de usuario proporcionado para suplantar tiene suficientes privilegios en el inquilino de QPP-NG,
  • En el caso de problemas específicos de la acción, consulte ejemplos y documentación compartida en el repositorio de código abierto en Github en Readme.md archivo o consulte el portal para desarrolladores de Quark para obtener más información sobre los puntos de conexión y la funcionalidad.

Preguntas más frecuentes

¿Puedo usar las acciones y desencadenadores con diferentes entornos de QPP-NG?

Sí, es posible. Solo tiene que rellenar el parámetro Nombre de host según el entorno y usar las conexiones adecuadas a ese entorno.

¿Puede ayudarnos si nos atascamos en algo o tiene dudas?

Totalmente. Simplemente envíe un correo electrónico [email protected] () yhttps://quarksoftware.my.site.com asegúrese de mencionar el conector de Microsoft Power Automate al describir su problema.

¿Dónde puedo obtener más información sobre las acciones y los puntos de conexión?

Puede encontrar más información sobre las diversas API de Quark aquí. Simplemente vaya a la pestaña Plataforma de contenido. Dado que este conector solo contiene un subconjunto de la API real posible para la plataforma QPP-NG, este sitio se puede usar para explorar y solicitar más acciones y puntos de conexión mediante el registro de una solicitud de característica en [email protected].

Creación de una conexión

El conector admite los siguientes tipos de autenticación:

Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Id. de cliente (clientId) cuerda / cadena Especifique el identificador de cliente de las credenciales de servicio. Cierto
Secreto de cliente (clientSecret) securestring Especifique el secreto de cliente de las credenciales de servicio. Cierto
Nombre del anfitrión cuerda / cadena Especificar el nombre de host Cierto

Limitaciones

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

Acciones

Actualizar asignación de atributos para el tipo de contenido

Actualice la asignación de atributos de tipos de contenido y elementos secundarios con el mapa de atributos especificado en el cuerpo de la solicitud. Consulte la documentación de GitHub para obtener más información.

Caja

Marca el recurso con el assetId especificado como Desprotegido. Consulte los documentos de Github para más información.

Carga (blob)

Esta solicitud se usa para cargar el archivo por flujo de entrada. Consulte la documentación de GitHub para obtener más información.

Crea un nuevo atributo

Crea un nuevo atributo y devuelve su identificador junto con un mensaje de operación correcta. Consulte la documentación de GitHub para obtener más información.

Crea un nuevo atributo List.

Crea un nuevo atributo y devuelve su identificador después de crear correctamente el mensaje de atributo. Para más información, consulte la documentación de GitHub.

Crear consulta

Cree una consulta con definición y detalles en el cuerpo de la solicitud. Consulte los documentos de GitHub para más información.

Descargar (blob)

Esta solicitud se usa para descargar el archivo por flujo de entrada desde la dirección URL de descarga. Consulte la documentación de GitHub para obtener más información.

Elimina webhook

Elimina un webhook ya existente para un evento determinado y un tipo de cambio. Para más información, consulte la documentación de GitHub.

Establecer valores de atributo

Establezca los valores de atributo para la plataforma QPP. Para más información, consulte la documentación de Github.

Iniciar nueva comprobación

La solicitud protegerá un archivo local, tal como se indica en la matriz de valores de atributo Qpp, por ejemplo, los valores de atributo necesarios son nombre, colección, extensión, etc. para proteger un recurso en QPPNG. Para más información, consulte la documentación de GitHub.

Inicio de la comprobación y actualización

La solicitud protegerá y actualizará un recurso ya existente en QPPNG. El recurso debe desprotegirse antes de su entrega. Use la acción de desprotección antes. Para más información, consulte la documentación de GitHub.

Obtención de metadatos de recursos

Obtiene los datos de recursos para el identificador de recurso determinado. Para más información, consulte la documentación de Github.

Obtención de resultados de consultas paginadas con filtros

Esta solicitud devuelve el elemento de consulta paginado y los detalles de una consulta almacenada en el sistema con un filtro específico en la consulta. Para más información, consulte la documentación de GitHub.

Obtención de valores de atributo de ids

Obtiene los valores de atributo para los identificadores separados por comas. Para más información, consulte la documentación de Github.

Obtener atributos por nombre

Devuelve todos los atributos existentes con metadatos en el servidor QPPNG para los nombres especificados. Consulte la documentación de GitHub para obtener más información.

Obtener estado de publicación

Obtiene el estado de publicación de un recurso determinado. Consulte los documentos de Github para más información.

Obtener flujo de trabajo por nombre

Esta solicitud devuelve todos los metadatos de un flujo de trabajo especificado por nombre. Consulte la documentación de Github para obtener más información.

Obtener grupo por nombre

Esta solicitud devolverá un grupo específico del nombre del grupo.

Obtener grupos para una colección

Esta solicitud devuelve una matriz de grupos de enrutamiento aplicables para la colección especificada para el flujo de trabajo y el estado especificados. Para más información, consulte la documentación de GitHub.

Obtener información de descarga de recursos

La solicitud devolverá información de descarga de recursos que se puede usar junto con la acción Descargar blob para descargar el flujo de recursos. Para más información, consulte la documentación de GitHub.

Obtener información de tipos de contenido por nombre

Esta solicitud se usa para recuperar la información del tipo de contenido por nombre de tipo de contenido. Consulte La documentación de Github para obtener más información.

Obtener miembros del grupo

Esta solicitud devolverá una lista de usuarios y todos sus metadatos específicos del identificador de grupo. Consulte la documentación de GitHub para obtener más información.

Obtener relaciones de recursos primarios

Esta solicitud devolverá la lista de relaciones de una relación de recursos primarios. Consulte la documentación de GitHub para obtener más información.

Obtener relaciones de recursos secundarios

Obtenga relaciones de recursos secundarios para proporcionar un identificador de recurso primario. Consulte la documentación de Github para obtener más información.

Obtener todas las consultas

Esta solicitud devolverá toda la consulta con la definición allí. Consulte la documentación de Github para obtener más información.

Obtener todos los usuarios

Esta solicitud se usa para capturar todos los usuarios. Consulte la documentación de Github para obtener más información.

Obtener token según el tipo de concesión

Esta solicitud captura el token del nombre de usuario y la contraseña especificados para QPPNG. Consulte la documentación de GitHub para obtener más información.

Obtener usuario por identificador

Esta solicitud se usa para capturar los metadatos de un usuario especificado. Consulte la documentación de GitHub para obtener más información.

Obtener usuario por nombre

Esta solicitud devolverá metadatos de usuario específicos del nombre de usuario. Consulte la documentación de GitHub para obtener más información.

Obtener valores de atributos por nombre

Obtiene los valores de atributo para los nombres separados por comas. Consulte la documentación de GitHub para obtener más información.

Publicar asincrónico de recursos

Devuelve el identificador de contexto del recurso que se está publicando. Use con get Publishing status (Obtener estado de publicación). Consulte la documentación de GitHub para obtener más información.

¿Es usuario un miembro de un grupo?

Esta solicitud devolverá true o false que un usuario es miembro del grupo específico del userId.

Actualizar asignación de atributos para el tipo de contenido

Actualice la asignación de atributos de tipos de contenido y elementos secundarios con el mapa de atributos especificado en el cuerpo de la solicitud. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de atributo
attributeId True integer

Identificadores de atributo que se deben asignar.

Identificadores de tipo de contenido
contentTypeIds True string

Tipos de contenido a los que se deben asignar estos atributos.

Caja

Marca el recurso con el assetId especificado como Desprotegido. Consulte los documentos de Github para más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True integer

AssetId variable debe hacer referencia al recurso del servidor QPP.

Id. de atributo
attributeId integer

Identificador del atributo .

Tipo
type integer

Tipo del atributo .

Importancia
attributeValue object

Valor.

Devoluciones

Body
Asset

Carga (blob)

Esta solicitud se usa para cargar el archivo por flujo de entrada. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Identificador de archivo
fileIdentifier True string

Identificador de archivo hace referencia al tipo de archivo.

context Id.
contextId True string

El identificador de contexto hace referencia a la información del recurso.

Recurso de flujo de entrada
InputStreamResource True

Flujo de entrada para el recurso, necesita entrada binaria.

Crea un nuevo atributo

Crea un nuevo atributo y devuelve su identificador junto con un mensaje de operación correcta. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre
name True string

Nombre del atributo.

Tipo de atributo
valueType True integer

Tipo de atributo.

Devoluciones

Detalles de un atributo asociado a una entidad.

Crea un nuevo atributo List.

Crea un nuevo atributo y devuelve su identificador después de crear correctamente el mensaje de atributo. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Número de dominios que se van a mostrar
_skiptoken True integer

Número de dominios que se van a omitir del menú desplegable Id. de dominio.

Nombre
name True string

Nombre del atributo.

Tipo de atributo
valueType True integer

El tipo de atributo debe ser una lista para el tipo de lista.

Multivalor
multiValued boolean

Indica si el atributo puede contener varios valores.

Acceso limitado
limitedAccess boolean

Solo se aplica al tipo de lista (indica si el atributo tiene una necesidad limitada de acceso para configurar los roles para esto antes).

Identificador de dominio
domainId integer

Identificador de dominio asociado a la lista de orígenes de datos o dominio existente. Use skip token para pasar por 20 elementos en la lista desplegable.

Devoluciones

Detalles de un atributo asociado a una entidad.

Crear consulta

Cree una consulta con definición y detalles en el cuerpo de la solicitud. Consulte los documentos de GitHub para más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Número de atributos que se van a omitir
_skiptoken True integer

Número de atributos que se van a omitir de la lista desplegable de atributos.

Nombre de consulta
queryName True string

Nombre de la consulta.

Parametrizados
parameterized boolean

Indica si la consulta está parametrizada.

Id. de atributo
attributeId integer

Id. de atributo de búsqueda.

Tipo de atributo
type integer

Tipo del atributo seleccionado para la condición.

Operadores de comparación
comparisonOperator integer

Operador de comparación para la condición.

Negado
negated boolean

Indica si la condición está negada.

Valor en el que se va a buscar
value string

valor en Buscar en.

Operador lógico
logicalOperator integer

Operador Lógico And OR para la condición.

ID de columna
columnId True integer

Identificador de la columna para mostrar.

Ancho
width True integer

Ancho de la columna para mostrar.

Columna de atributo
attributeColumn True boolean

Indica si la columna es una columna de atributo.

Modo de presentación
displayMode True integer

Configuración del modo de presentación.

Devoluciones

Identificador de consulta recién creado.

Identificador de consulta recién creado
integer

Descargar (blob)

Esta solicitud se usa para descargar el archivo por flujo de entrada desde la dirección URL de descarga. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Token de autenticación
authTokenforHeader True string

Token de autenticación necesario aquí por separado. La acción TokenFromAuthWrapper se puede usar aquí para capturar el token.

Identificador de archivo
fileIdentifier True string

Identificador de archivo hace referencia al tipo de archivo.

Id. de contexto
contextId True string

El identificador de contexto hace referencia a la información del recurso.

Devoluciones

Nombre Ruta de acceso Tipo Description
Tipo de contenido
$content-type string

El tipo de contenido del documento, por ejemplo, application/pdf.

Content
$content byte

Contenido del documento en codificación Base64.

Elimina webhook

Elimina un webhook ya existente para un evento determinado y un tipo de cambio. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre o identificador
nameOrId True string

Nombre o identificador del webhook existente en el entorno.

Devoluciones

Establecer valores de atributo

Establezca los valores de atributo para la plataforma QPP. Para más información, consulte la documentación de Github.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True string

Id. de recurso de la plataforma QPP.

Id. de atributo
attributeId integer

Identificador del atributo .

Tipo
type integer

Tipo del atributo .

Multivalor
multiValued boolean

Indica si el atributo tiene varios valores.

Importancia
attributeValue object

Valor.

Iniciar nueva comprobación

La solicitud protegerá un archivo local, tal como se indica en la matriz de valores de atributo Qpp, por ejemplo, los valores de atributo necesarios son nombre, colección, extensión, etc. para proteger un recurso en QPPNG. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Número de atributos o dominios que se van a omitir
_skiptoken True integer

Número de atributos o dominios que se van a omitir.

Crear versión secundaria
createMinorVersion True boolean

La variable createMinorVersion debe hacer referencia a true o false para crear la versión para la comprobación.

Id. de atributo
attributeId integer

Id. de atributo.

Tipo de atributo
type integer

Tipo de atributo.

Multivalor
multiValued boolean

Indica si el atributo tiene varios valores.

Id
id integer

Se toma el identificador correspondiente al nombre, como para el identificador de colección de inicio 1.

Nombre
name string

Nombre del atributo, como el nombre del tipo de contenido o el nombre de la colección.

Identificador de dominio
domainId integer

Identificador de dominio asociado a la lista de orígenes de datos o dominio existente. Su identificador para el dominio.

Importancia
value string

Valor del atributo que se va a establecer.

Identificador de valor de dominio
id integer

El identificador del propio valor de dominio, por ejemplo, el identificador de un valor de dominio para un usuario será el identificador de usuario, ya que la lista Usuarios es el dominio.

Devoluciones

Inicio de la comprobación y actualización

La solicitud protegerá y actualizará un recurso ya existente en QPPNG. El recurso debe desprotegirse antes de su entrega. Use la acción de desprotección antes. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Crear versión secundaria
createMinorVersion True boolean

La variable createMinorVersion debe hacer referencia a true o false para crear la versión para la comprobación.

Id. de recurso
assetId integer

Id. de recurso para el recurso que se va a comprobar.

Devoluciones

Obtención de metadatos de recursos

Obtiene los datos de recursos para el identificador de recurso determinado. Para más información, consulte la documentación de Github.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True integer

Identificador del recurso en la plataforma QPPNG a la que se apunta.

Devoluciones

Body
Asset

Obtención de resultados de consultas paginadas con filtros

Esta solicitud devuelve el elemento de consulta paginado y los detalles de una consulta almacenada en el sistema con un filtro específico en la consulta. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Identificador de consulta QPPNG existente
queryId True integer

Esto hace referencia a un identificador de consulta QPPNG existente.

Identificador de consulta
queryId integer

Identificador único de la consulta.

Nombre de consulta
queryName string

Nombre de la consulta.

Id. del propietario
ownerId integer

Identificador del propietario de la consulta.

Parametrizados
parameterized boolean

Indica si la consulta está parametrizada.

ID de columna
columnId True integer

Identificador de la columna para mostrar.

Ancho
width True integer

Ancho de la columna para mostrar.

Columna de atributo
attributeColumn True boolean

Indica si la columna es una columna de atributo.

ID de columna
columnId integer

Identificador de la columna para la ordenación.

Descending
descending boolean

Indica si la ordenación está en orden descendente.

Columna de atributo
attributeColumn boolean

Indica si la columna ordenada es una columna de atributo.

Modo de presentación
displayMode True integer

Configuración del modo de presentación.

Id. de atributo
attributeId integer

Identificador del atributo para la agrupación.

Descending
descending boolean

Indica si la agrupación está en orden descendente.

Explorar modo
exploreMode integer

Explorar la configuración del modo.

Operador lógico
logicalOperator True integer

Operador lógico para la condición.

Operadores de comparación
comparisonOperator True integer

Operador de comparación para la condición.

Negado
negated True boolean

Indica si la condición está negada.

Parametrizados
parameterized True boolean

Indica si la condición está parametrizada.

Tipo
type True integer

Tipo de la condición.

Id. de atributo
attributeId True integer

Id. de atributo de búsqueda.

Valor en el que se va a buscar
value True string

valor en Buscar en.

Tipo de contenido
contentType integer

Identificador del tipo de contenido para el contexto de consulta.

Collections
collections array of integer

Lista de identificadores de colección para el contexto de consulta.

Recursivo
recursive boolean

Indica si el contexto de consulta es recursivo.

Incluir todas las versiones
includeAllVersions boolean

Indica si todas las versiones se incluyen en el contexto de consulta.

Incluir ramas
includeBranches boolean

Indica si las ramas se incluyen en el contexto de consulta.

queryResults
queryResults

Devoluciones

Elemento Response para enumerar los resultados de la consulta.

Elemento List Response Query Result
ListResponseQueryResultElement

Obtención de valores de atributo de ids

Obtiene los valores de atributo para los identificadores separados por comas. Para más información, consulte la documentación de Github.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True integer

Identificador del recurso en la plataforma QPPNG a la que se apunta.

Identificadores de atributo QPPNG
attributeIds True string

Los identificadores de atributo deben hacer referencia a los identificadores de atributo del servidor QPP.

Devoluciones

Obtener atributos por nombre

Devuelve todos los atributos existentes con metadatos en el servidor QPPNG para los nombres especificados. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombres de atributo
attributeNames True string

Nombre del atributo debe hacer referencia al nombre de atributo del servidor QPP (separado por comas, si es múltiple).

Devoluciones

Obtener estado de publicación

Obtiene el estado de publicación de un recurso determinado. Consulte los documentos de Github para más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de contexto
contextId True string

Id. de contexto

Devoluciones

Obtener flujo de trabajo por nombre

Esta solicitud devuelve todos los metadatos de un flujo de trabajo especificado por nombre. Consulte la documentación de Github para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre del flujo de trabajo
workflowName True string

Nombre del flujo de trabajo para el que se deben capturar los metadatos.

Devoluciones

Detalles de un flujo de trabajo.

Flujo de trabajo
Workflow

Obtener grupo por nombre

Esta solicitud devolverá un grupo específico del nombre del grupo.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre de grupo
groupName True string

GroupName de variables debe hacer referencia al nombre del grupo de servidores QPP.

Devoluciones

Body
Group

Obtener grupos para una colección

Esta solicitud devuelve una matriz de grupos de enrutamiento aplicables para la colección especificada para el flujo de trabajo y el estado especificados. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Identificador de la colección QPPNG
collectionId True integer

CollectionId de variables debe hacer referencia al identificador de colección QPPNG.

Devoluciones

Obtener información de descarga de recursos

La solicitud devolverá información de descarga de recursos que se puede usar junto con la acción Descargar blob para descargar el flujo de recursos. Para más información, consulte la documentación de GitHub.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True integer

AssetId debe hacer referencia al recurso del servidor QPP.

Versión Menor
minorVersion integer

La versión secundaria debe hacer referencia a la versión secundaria del recurso necesario. Proporcione 0 para capturar metadatos de la versión más reciente.

Versión Principal
majorVersion integer

La versión principal debe hacer referencia a la versión principal del recurso necesario. Proporcione null para capturar metadatos de la versión más reciente.

Devoluciones

Obtener información de tipos de contenido por nombre

Esta solicitud se usa para recuperar la información del tipo de contenido por nombre de tipo de contenido. Consulte La documentación de Github para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre del tipo de contenido
contentTypeName True string

Nombre del tipo de contenido.

Devoluciones

Obtener miembros del grupo

Esta solicitud devolverá una lista de usuarios y todos sus metadatos específicos del identificador de grupo. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de grupo
groupId True integer

El identificador de grupo debe hacer referencia al grupo QPPNG.

Devoluciones

response
array of User

Obtener relaciones de recursos primarios

Esta solicitud devolverá la lista de relaciones de una relación de recursos primarios. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Identificador de recurso secundario
childAssetId True integer

ChildAssetId variable debe hacer referencia al recurso secundario del servidor QPP que tiene relación con el elemento primario y para el que es necesario averiguar las relaciones primarias.

Devoluciones

Obtener relaciones de recursos secundarios

Obtenga relaciones de recursos secundarios para proporcionar un identificador de recurso primario. Consulte la documentación de Github para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso primario
parentAssetId True integer

El identificador de recurso primario debe hacer referencia al recurso primario del servidor QPP.

Devoluciones

Obtener todas las consultas

Esta solicitud devolverá toda la consulta con la definición allí. Consulte la documentación de Github para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Devoluciones

Obtener todos los usuarios

Esta solicitud se usa para capturar todos los usuarios. Consulte la documentación de Github para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Devoluciones

Elemento Response para enumerar usuarios.

Enumerar usuario de respuesta
ListResponseUser

Obtener token según el tipo de concesión

Esta solicitud captura el token del nombre de usuario y la contraseña especificados para QPPNG. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Nombre de usuario
username True string

Escriba el nombre de usuario del entorno QPPNG para el que necesita obtener el token.

Contraseña
password True string

Escriba la contraseña del nombre de usuario.

Devoluciones

Nombre Ruta de acceso Tipo Description
Token de acceso
access_token string

Token que concede acceso a los recursos protegidos.

Expira en
expires_in integer

Duración (en segundos) para la que el token de acceso es válido.

La actualización expira en
refresh_expires_in integer

Duración (en segundos) para la que el token de actualización es válido.

Tipo de token
token_type string

Tipo del token (por ejemplo, portador).

No antes de la directiva
not-before-policy integer

Tiempo (en segundos) antes del cual no se puede usar el token.

Ámbito
scope string

Ámbito del token de acceso.

Obtener usuario por identificador

Esta solicitud se usa para capturar los metadatos de un usuario especificado. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de usuario de QPPNG
userId True integer

Identificador del usuario QPPNG.

Devoluciones

Body
User

Obtener usuario por nombre

Esta solicitud devolverá metadatos de usuario específicos del nombre de usuario. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre de usuario del usuario QPPNG
userName True string

Esto hace referencia al nombre de usuario para el usuario QPPNG.

Devoluciones

Body
User

Obtener valores de atributos por nombre

Obtiene los valores de atributo para los nombres separados por comas. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True integer

AssetId debe hacer referencia al recurso del servidor QPP.

Nombres de atributo
attributes True string

La cadena de nombres de atributo debe hacer referencia a los nombres de atributo del servidor QPPNG, separados por comas si hay varios.

Devoluciones

Publicar asincrónico de recursos

Devuelve el identificador de contexto del recurso que se está publicando. Use con get Publishing status (Obtener estado de publicación). Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Id. de recurso
assetId True string

AssetId variable debe hacer referencia al recurso del servidor QPP.

Identificador del canal de publicación
publishingChannelId True string

channelId de variable debe hacer referencia al identificador del canal que se va a usar.

Devoluciones

Identificador de contexto para el recurso que se está publicando. Use con get Publishing status (Obtener estado de publicación) para comprobar el estado de publicación.

Id. de contexto
string

¿Es usuario un miembro de un grupo?

Esta solicitud devolverá true o false que un usuario es miembro del grupo específico del userId.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Identificador del usuario QPPNG
userId True integer

Identificador del usuario QPPNG.

Identificador de grupo en QPPNG
groupId True integer

Identificador de grupo en QPPNG.

Desencadenadores

Desencadena cuando se produce un evento para un webhook ya registrado

Registra un webhook para un evento determinado y un tipo de cambio. Consulte la documentación de GitHub para obtener más información.

Desencadena cuando se produce un evento para un webhook ya registrado

Registra un webhook para un evento determinado y un tipo de cambio. Consulte la documentación de GitHub para obtener más información.

Parámetros

Nombre Clave Requerido Tipo Description
Usuario de suplantación
user_name True string

Nombre de usuario del usuario QPPNG, que debe suplantarse.

Nombre del webhook
name True string

Nombre único para describir el propósito y el significado de los webhooks.

Tipo de webhook
type True string

Describir el tipo de webhook al que se escuchará, como Evento, etc.

Objeto
object True string

Describe el tipo de objeto que se va a escuchar como ASSET, etc.

Tipo de cambio
changeType True array of string
Criterios de filtro
filter string

Los criterios de filtro se pueden definir para filtrar el tipo de evento.

Versión usada
version True string

Versión que se usa según el servicio de webhook en la plataforma QPPNG.

Devoluciones

Nombre Ruta de acceso Tipo Description
Versión usada
version string

Versión que se usa según el servicio de webhook en la plataforma QPPNG.

Tipo de webhook
webhookInfo.type string

Describir el tipo de webhook al que se escuchará, como Evento, etc.

Identificador de webhook
webhookInfo.id string

Id. de webhook.

Nombre del webhook
webhookInfo.name string

Nombre único para describir el propósito y el significado de los webhooks.

AuxData
webhookInfo.auxData string

AuxData si se proporciona al registrarse.

Definiciones

PublishingOutputDownloadInfo

Define la información de descarga de salida de publicación.

Nombre Ruta de acceso Tipo Description
attributesMap
attributesMap object
Descarga directa
directDownload boolean

Define si se permite la descarga directa.

URL de descarga
downloadUrl string

Proporciona la dirección URL de descarga que se puede usar con la acción de descarga del blob para descargar desde la ubicación del blob.

WebhookSuccessResponse

Nombre Ruta de acceso Tipo Description
identificación
id string

Define el identificador de la respuesta correcta del webhook.

Estado
status string

Define el estado de la respuesta correcta del webhook.

Message
message string

Define el mensaje para la respuesta correcta del webhook.

Versión
version string

Define la versión de la respuesta correcta del webhook.

AttributeValue

Nombre Ruta de acceso Tipo Description
Id. de atributo
attributeId integer

Define el identificador de atributo para el atributo QPPNG.

Nombre del atributo
attributeName string

Define el nombre de atributo para el atributo QPPNG.

Tipo
type integer

Define el tipo para el atributo QPPNG.

Multivalor
multiValued boolean

Define si el atributo tiene varios valores.

Importancia
attributeValue Value

Valor.

AssetUploadInfo

Nombre Ruta de acceso Tipo Description
Id. de contexto
contextId string

Define el identificador de contexto para la carga de recursos.

Dirección URL de carga
uploadUrl string

Define la dirección URL de carga del recurso.

Activo

Nombre Ruta de acceso Tipo Description
Identificador de activo
assetId integer

Define el identificador de recurso para el recurso QPPNG.

assetVersion
assetVersion AssetVersion
attributeValues
attributeValues array of AttributeValue

Usuario

Nombre Ruta de acceso Tipo Description
identificación
id integer

Id. de usuario

Nombre
name string

Nombre del usuario.

Identificador de dominio
domainId integer

Identificador de dominio del usuario.

Referencia de origen
sourceReference string

Referencia de origen para el usuario.

Valores de dominio secundarios
childDomainValues array of DomainValue

Matriz de valores de dominio secundarios.

Tiene hijos
hasChildren boolean

Indica si el usuario tiene elementos secundarios.

Está eliminado
isDeleted boolean

Indica si se elimina el usuario.

Es usuario
user boolean

Indica si la entidad es un usuario.

Id. de perfil LDAP
ldapProfileId integer

Id. de perfil LDAP para el usuario.

Identificador de clase de usuario predeterminado
defaultUserClassId integer

Identificador de clase de usuario predeterminado.

Dirección de correo electrónico
emailAddress string

Dirección de correo electrónico del usuario.

Está eliminado
deleted boolean

Indica si se elimina el usuario.

Nombre distintivo LDAP
ldapDistinguishedName string

Nombre distintivo LDAP para el usuario.

Administrador de confianza nativo
nativeTrustee boolean

Indica si el usuario es un administrador de confianza nativo.

Nombre
firstName string

Nombre del usuario.

Apellido
lastName string

Apellidos del usuario.

Número de teléfono
phoneNumber string

Número de teléfono del usuario.

Está habilitado
enabled boolean

Indica si el usuario está habilitado.

Autenticado externamente
externallyAuthenticated boolean

Indica si el usuario está autenticado externamente.

Nombre de la autenticación
nameForAuthentication string

Nombre de la autenticación.

ListResponseCollectionGroup

Nombre Ruta de acceso Tipo Description
Contar
get_count integer

Número de elementos de la respuesta.

Vínculo siguiente
get_nextLink string

Dirección URL del siguiente conjunto de resultados.

Importancia
get_value array of CollectionGroup

Matriz de grupos de recopilación.

Importancia

Valor.

Nombre Ruta de acceso Tipo Description
Importancia
object

Valor.

AssetVersion

Nombre Ruta de acceso Tipo Description
Versión Principal
majorVersion integer

Versión principal del recurso.

Versión Menor
minorVersion integer

Versión secundaria del recurso.

Id. de sucursal
branchId integer

Id. de versión de rama.

Nombre del sistema
systemName string

Nombre del sistema para la versión del recurso.

DomainValue

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador de valor de dominio.

Nombre
name string

Nombre del valor de dominio.

Identificador de dominio
domainId integer

Identificador de dominio del valor de dominio.

Referencia de origen
sourceReference string

Referencia de origen del valor de dominio.

Valores de dominio secundarios
childDomainValues string

Matriz de valores de dominio secundarios.

Tiene hijos
hasChildren boolean

Indica si el valor del dominio tiene elementos secundarios.

Está eliminado
isDeleted boolean

Indica si se elimina el valor del dominio.

CollectionGroup

Nombre Ruta de acceso Tipo Description
Identificador de grupo
groupId integer

Identificador del grupo de recopilación.

groupInfo
groupInfo GroupInfo
Identificador de clase de usuario invalidado
overriddenUserClassId integer

Identificador de la clase de usuario invalidada.

GroupInfo

Nombre Ruta de acceso Tipo Description
identificación
id integer

Id. de grupo.

Nombre
name string

Nombre del grupo.

Identificador de dominio
domainId integer

Identificador de dominio del grupo.

Referencia de origen
sourceReference string

Referencia de origen del grupo.

Valores de dominio secundarios
childDomainValues array of DomainValue

Matriz de valores de dominio secundarios.

Tiene hijos
hasChildren boolean

Indica si el grupo tiene elementos secundarios.

Está eliminado
isDeleted boolean

Indica si se elimina el grupo.

Es usuario
user boolean

Indica si el grupo representa a un usuario.

Id. de perfil LDAP
ldapProfileId integer

Id. de perfil LDAP.

Identificador de clase de usuario predeterminado
defaultUserClassId integer

Identificador de la clase de usuario predeterminada.

Dirección de correo electrónico
emailAddress string

Dirección de correo electrónico del grupo.

Borrado
deleted boolean

Indica si se elimina el grupo.

Nombre distintivo LDAP
ldapDistinguishedName string

Nombre distintivo LDAP del grupo.

Administrador de confianza nativo
nativeTrustee boolean

Indica si el grupo es un administrador de confianza nativo.

AssetDownloadInfo

Nombre Ruta de acceso Tipo Description
Id. de contexto
contextId string

Identificador del contexto.

Dirección URL de descarga
downloadUrl string

Dirección URL para descargar el recurso.

Flujo de trabajo

Detalles de un flujo de trabajo.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único del flujo de trabajo.

Nombre
name string

Nombre del flujo de trabajo.

Identificador de dominio
domainId integer

Identificador del dominio asociado al flujo de trabajo.

Referencia de origen
sourceReference string

Referencia asociada al origen del flujo de trabajo.

Valores de dominio secundarios
childDomainValues array of DomainValue

Lista de valores de dominio secundarios asociados al flujo de trabajo.

Tiene hijos
hasChildren boolean

Indica si el flujo de trabajo tiene elementos secundarios.

Está eliminado
isDeleted boolean

Indica si el flujo de trabajo se ha marcado como eliminado.

Estados
statuses array of Status

Lista de estados en el flujo de trabajo.

Autor
createdBy integer

Identificador de usuario del creador del flujo de trabajo.

Fecha de creación
created string

Fecha en que se creó el flujo de trabajo.

Última modificación realizada por
lastModifiedBy integer

Identificador de usuario del último modificador del flujo de trabajo.

Fecha de última modificación
lastModified string

Fecha en la que se modificó por última vez el flujo de trabajo.

Transición de estado restringido
constrainedStatusTransition boolean

Define si la transición de estado está restringida.

Clases de usuario de enrutamiento de estado
statusRoutingUserclasses array of StatusRoutingUserClasses

Lista de clases de usuario de enrutamiento de estado.

Transiciones de estado
statusTransitions array of StatusTransition

Lista de transiciones de estado.

Estado

Representa un estado.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único del estado.

Nombre
name string

Nombre del estado.

Identificador de dominio
domainId integer

Identificador de dominio para el estado.

Referencia de origen
sourceReference string

Referencia al origen del estado.

Valores de dominio secundarios
childDomainValues array of DomainValue

Matriz de valores de dominio secundarios.

Tiene hijos
hasChildren boolean

Indica si el estado tiene estados secundarios.

Está eliminado
isDeleted boolean

Indica si se elimina el estado.

Id. de flujo de trabajo
workflowId integer

Identificador del flujo de trabajo asociado al estado.

Color rojo
colorRed integer

Componente rojo del color de estado.

Color verde
colorGreen integer

Componente verde del color de estado.

Color azul
colorBlue integer

Componente azul del color de estado.

Position
position integer

Posición del estado.

StatusRoutingUserClasses

Asignación de estado a clases de usuario para el enrutamiento.

Nombre Ruta de acceso Tipo Description
Id. de estado
statusId integer

Identificador del estado para el enrutamiento.

Identificadores de clase de usuario de enrutamiento
routingUserClassIds array of integer

Matriz de identificadores de clase de usuario para el enrutamiento.

Enrutamiento basado en clases de usuario
userClassBasedRouting boolean

Indica si el enrutamiento basado en clases de usuario está habilitado.

StatusTransition

Detalles de una transición de estado dentro de un flujo de trabajo.

Nombre Ruta de acceso Tipo Description
Id. de estado
statusId integer

Identificador de la transición de estado.

Estado de inicio del flujo de trabajo
workflowInitiatingStatus boolean

Indica si el flujo de trabajo inicia la transición.

Siguientes identificadores de estado posibles
nextPossibleStatusIds array of integer

Identificadores de los siguientes estados posibles después de esta transición.

AssetRelation

Detalles de una relación entre los recursos.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único de la relación de recursos.

Id. de recurso primario
parentAssetId integer

Identificador del recurso primario en la relación.

parentAssetVersion
parentAssetVersion AssetVersion
Id. de recurso secundario
childAssetId integer

Identificador del recurso secundario en la relación.

childAssetVersion
childAssetVersion AssetVersion
Id. de tipo de relación
relationTypeId integer

Identificador del tipo de relación.

Estado de relación
relationState integer

Estado de la relación.

Bloqueado a la versión secundaria
lockedToChildVersion boolean

Marca que indica si la relación está bloqueada para la versión secundaria.

Inmovilizar a la versión actual
freezeToCurrentVersion boolean

Marca que indica si la relación está inmovilizada a la versión actual.

Atributos de relación
relationAttributes array of AttributeValue

Atributos asociados a la relación.

Atributo

Detalles de un atributo asociado a una entidad.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único del atributo.

Nombre
name string

Nombre del atributo.

Tipo de valor
valueType integer

Tipo de valor que contiene el atributo.

Definido por el usuario
userDefined boolean

Indica si el atributo está definido por el usuario.

Consultable
queryable boolean

Indica si el atributo es consultable.

Multivalor
multiValued boolean

Indica si el atributo puede contener varios valores.

Nivel de modificación
modificationLevel integer

Nivel de modificación del atributo.

Fecha de creación
created string

Fecha en que se creó el atributo.

Fecha de última modificación
lastModified string

Fecha en la que se modificó por última vez el atributo.

Creador
creator integer

Identificador del usuario que creó el atributo .

Último modificador
lastModifier integer

Identificador del usuario que modificó el atributo por última vez.

Visualizables
displayable boolean

Indica si el atributo se puede mostrar.

Acceso limitado
limitedAccess boolean

Indica si el atributo tiene acceso limitado.

Acceso limitado modificable
limitedAccessChangeable boolean

Indica si se puede cambiar la configuración de acceso limitado.

Restricciones modificables
constraintsChangeable boolean

Indica si se pueden cambiar las restricciones del atributo.

Preferencias de valor modificables
valuePreferencesChangeable boolean

Indica si se pueden cambiar las preferencias de valor.

Preferencias de valor booleano
booleanValuePreferences BooleanValuePreferences

Preferencias para valores booleanos.

Preferencias de valores numéricos
numericValuePreferences NumericValuePreferences

Preferencias para valores numéricos.

Preferencias de valor de fecha
dateValuePreferences DateValuePreferences

Preferencias para los valores de fecha.

Preferencias de valor de DateTime
dateTimeValuePreferences DateTimeValuePreferences

Preferencias para valores DateTime.

Preferencias de valor de hora
timeValuePreferences TimeValuePreferences

Preferencias para los valores de hora.

Preferencias de valor de medida
measurementValuePreferences MeasurementValuePreferences

Preferencias para los valores de medida.

Preferencias de valor de texto
textValuePreferences TextValuePreferences

Preferencias para los valores de texto.

Preferencias de lista de valores de dominio
domainValueListPreferences DomainValueListPreferences

Preferencias para listas de valores de dominio.

Preferencias de valor de dominio
domainValuePreferences DomainValuePreferences

Preferencias para los valores de dominio.

CreateAttributeSchema

Detalles de un atributo asociado a una entidad.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único del atributo.

Nombre
name string

Nombre del atributo.

Tipo de valor
valueType integer

Tipo de valor que el atributo contiene 1 para el tipo de texto, etc.

Definido por el usuario
userDefined boolean

Indica si el atributo está definido por el usuario.

Consultable
queryable boolean

Indica si el atributo es consultable.

Multivalor
multiValued boolean

Indica si el atributo puede contener varios valores.

Nivel de modificación
modificationLevel integer

Nivel de modificación del atributo.

Fecha de creación
created string

Fecha en que se creó el atributo.

Fecha de última modificación
lastModified string

Fecha en la que se modificó por última vez el atributo.

Creador
creator integer

Identificador del usuario que creó el atributo .

Último modificador
lastModifier integer

Identificador del usuario que modificó el atributo por última vez.

Visualizables
displayable boolean

Indica si el atributo se puede mostrar.

Acceso limitado
limitedAccess boolean

Indica si el atributo tiene acceso limitado.

Acceso limitado modificable
limitedAccessChangeable boolean

Indica si se puede cambiar la configuración de acceso limitado.

Restricciones modificables
constraintsChangeable boolean

Indica si se pueden cambiar las restricciones del atributo.

Preferencias de valor modificables
valuePreferencesChangeable boolean

Indica si se pueden cambiar las preferencias de valor.

Preferencias de valor booleano
booleanValuePreferences BooleanValuePreferences

Preferencias para valores booleanos.

Preferencias de valores numéricos
numericValuePreferences NumericValuePreferences

Preferencias para valores numéricos.

Preferencias de valor de fecha
dateValuePreferences DateValuePreferences

Preferencias para los valores de fecha.

Preferencias de valor de DateTime
dateTimeValuePreferences DateTimeValuePreferences

Preferencias para valores DateTime.

Preferencias de valor de hora
timeValuePreferences TimeValuePreferences

Preferencias para los valores de hora.

Preferencias de valor de medida
measurementValuePreferences MeasurementValuePreferences

Preferencias para los valores de medida.

Preferencias de valor de texto
textValuePreferences TextValuePreferences

Preferencias para los valores de texto.

Preferencias de lista de valores de dominio
domainValueListPreferences DomainValueListPreferences

Preferencias para listas de valores de dominio.

Preferencias de valor de dominio
domainValuePreferences DomainValuePreferences

Preferencias para los valores de dominio.

ContentTypeInfo

Detalles de un tipo de contenido.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único del tipo de contenido.

Nombre
name string

Nombre del tipo de contenido.

Identificador de dominio
domainId integer

Identificador de dominio asociado al tipo de contenido.

Referencia de origen
sourceReference string

Referencia al origen del tipo de contenido.

Valores de dominio secundarios
childDomainValues array of DomainValue

Lista de valores de dominio secundarios asociados al tipo de contenido.

Tiene hijos
hasChildren boolean

Indica si el tipo de contenido tiene elementos secundarios.

Está eliminado
isDeleted boolean

Indica si se elimina el tipo de contenido.

Definido por el sistema
systemDefined boolean

Indica si el tipo de contenido está definido por el sistema.

Elementos secundarios disponibles
childrenAvailable boolean

Indica si los elementos secundarios están disponibles para el tipo de contenido.

Extensible
extensible boolean

Indica si el tipo de contenido es extensible.

BooleanValuePreferences

Preferencias para valores booleanos.

Nombre Ruta de acceso Tipo Description
Valor booleano
defaultValue BooleanValue

Valor booleano.

BooleanValue

Valor booleano.

Nombre Ruta de acceso Tipo Description
Importancia
value boolean

Valor booleano.

NumericValuePreferences

Preferencias para valores numéricos.

Nombre Ruta de acceso Tipo Description
Valor numérico
minimumPossibleValue NumericValue

Valor numérico.

Valor numérico
maximumPossibleValue NumericValue

Valor numérico.

Valor numérico
defaultValue NumericValue

Valor numérico.

NumericValue

Valor numérico.

Nombre Ruta de acceso Tipo Description
Importancia
value integer

Valor numérico.

DateValue

Valor de fecha.

Nombre Ruta de acceso Tipo Description
Importancia
value string

Valor de fecha.

DateValuePreferences

Preferencias para los valores de fecha.

Nombre Ruta de acceso Tipo Description
Valor de fecha
minimumPossibleValue DateValue

Valor de fecha.

Valor de fecha
maximumPossibleValue DateValue

Valor de fecha.

Valor de fecha
defaultValue DateValue

Valor de fecha.

DateTimeValue

Valor DateTime.

Nombre Ruta de acceso Tipo Description
Importancia
value string

Valor DateTime.

DateTimeValuePreferences

Preferencias para valores DateTime.

Nombre Ruta de acceso Tipo Description
Valor dateTime
minimumPossibleValue DateTimeValue

Valor DateTime.

Valor dateTime
maximumPossibleValue DateTimeValue

Valor DateTime.

Valor dateTime
defaultValue DateTimeValue

Valor DateTime.

TimeValue

Valor de hora.

Nombre Ruta de acceso Tipo Description
Importancia
value string

Valor de hora.

TimeValuePreferences

Preferencias para los valores de hora.

Nombre Ruta de acceso Tipo Description
Valor de hora
minimumPossibleValue TimeValue

Valor de hora.

Valor de hora
maximumPossibleValue TimeValue

Valor de hora.

Valor de hora
defaultValue TimeValue

Valor de hora.

MeasurementValue

Valor de medida.

Nombre Ruta de acceso Tipo Description
Importancia
value double

Valor de medida.

MeasurementValuePreferences

Preferencias para los valores de medida.

Nombre Ruta de acceso Tipo Description
Unidad de medida
measurementUnit integer

Unidad de medida.

Solo se puede cambiar la unidad de medida
onlyMeasurementUnitChangeable boolean

Indica si solo se puede cambiar la unidad de medida.

Valor de medida
minimumPossibleValue MeasurementValue

Valor de medida.

Valor de medida
maximumPossibleValue MeasurementValue

Valor de medida.

Valor de medida
defaultValue MeasurementValue

Valor de medida.

TextValue

Valor de texto

Nombre Ruta de acceso Tipo Description
Importancia
value string

El valor de texto.

TextValuePreferences

Preferencias para los valores de texto.

Nombre Ruta de acceso Tipo Description
Valor de texto
defaultValue TextValue

Valor de texto

Longitud máxima posible
maxLengthPossible integer

Longitud máxima posible para el valor de texto.

Búsqueda de texto habilitada
textSearchEnabled boolean

Indica si la búsqueda de texto está habilitada.

DomainValueList

Lista de valores de dominio.

Nombre Ruta de acceso Tipo Description
Valores de dominio
domainValues array of DomainValue

Lista de valores de dominio.

DomainValueListPreferences

Preferencias para listas de valores de dominio.

Nombre Ruta de acceso Tipo Description
Lista de valores de dominio
defaultValue DomainValueList

Lista de valores de dominio.

Identificador de dominio
domainId integer

Identificador de dominio asociado a la lista de valores de dominio.

DomainValuePreferences

Preferencias para los valores de dominio.

Nombre Ruta de acceso Tipo Description
defaultValue
defaultValue DomainValue
Identificador de dominio
domainId integer

Identificador de dominio asociado al valor de dominio.

QueryDefinition

Definición de una consulta.

Nombre Ruta de acceso Tipo Description
Identificador de consulta
queryId integer

Identificador único de la consulta.

Nombre de consulta
queryName string

Nombre de la consulta.

Id. del propietario
ownerId integer

Identificador del propietario de la consulta.

Parametrizados
parameterized boolean

Indica si la consulta está parametrizada.

Visualización de consultas
queryDisplay QueryDisplay

Mostrar la configuración de una consulta.

Condiciones de consulta
queryConditions array of QueryCondition

Lista de condiciones de consulta.

Contexto de consulta
queryContext QueryContext

Configuración de contexto para una consulta.

queryResults
queryResults

QueryDisplay

Mostrar la configuración de una consulta.

Nombre Ruta de acceso Tipo Description
Mostrar columnas
displayColumns array of DisplayColumn

Lista de columnas para mostrar.

Ordenación
sorting array of SortInfo

Lista de opciones de ordenación.

Modo de presentación
displayMode integer

Configuración del modo de presentación.

Atributos de agrupación
groupingAttributes array of GroupingInfo

Lista de atributos de agrupación.

Explorar modo
exploreMode integer

Explorar la configuración del modo.

QueryCondition

Condición de una consulta.

Nombre Ruta de acceso Tipo Description
Operador lógico
logicalOperator integer

Operador lógico para la condición.

Operadores de comparación
comparisonOperator integer

Operador de comparación para la condición.

Negado
negated boolean

Indica si la condición está negada.

Parametrizados
parameterized boolean

Indica si la condición está parametrizada.

Tipo
type integer

Tipo de la condición.

Id. de atributo
attributeId integer

Id. de atributo de búsqueda.

Valor en el que se va a buscar
value string

valor en Buscar en.

QueryContext

Configuración de contexto para una consulta.

Nombre Ruta de acceso Tipo Description
Tipo de contenido
contentType integer

Identificador del tipo de contenido para el contexto de consulta.

Collections
collections array of integer

Lista de identificadores de colección para el contexto de consulta.

Recursivo
recursive boolean

Indica si el contexto de consulta es recursivo.

Incluir todas las versiones
includeAllVersions boolean

Indica si todas las versiones se incluyen en el contexto de consulta.

Incluir ramas
includeBranches boolean

Indica si las ramas se incluyen en el contexto de consulta.

DisplayColumn

Columna para mostrar en una consulta.

Nombre Ruta de acceso Tipo Description
ID de columna
columnId integer

Identificador de la columna para mostrar.

Ancho
width integer

Ancho de la columna para mostrar.

Columna de atributo
attributeColumn boolean

Indica si la columna es una columna de atributo.

SortInfo

Configuración de ordenación de una consulta.

Nombre Ruta de acceso Tipo Description
ID de columna
columnId integer

Identificador de la columna para la ordenación.

Descending
descending boolean

Indica si la ordenación está en orden descendente.

Columna de atributo
attributeColumn boolean

Indica si la columna ordenada es una columna de atributo.

GroupingInfo

Configuración de agrupación para una consulta.

Nombre Ruta de acceso Tipo Description
Id. de atributo
attributeId integer

Identificador del atributo para la agrupación.

Descending
descending boolean

Indica si la agrupación está en orden descendente.

ListResponseQueryResultElement

Elemento Response para enumerar los resultados de la consulta.

Nombre Ruta de acceso Tipo Description
Contar
get_count integer

Número de resultados en la respuesta de la lista.

Vínculo siguiente
get_nextLink string

Enlace a la siguiente página de resultados.

Importancia
get_value array of QueryResultElement

Matriz de elementos de resultados de consulta.

QueryResultElement

Elemento de un resultado de consulta.

Nombre Ruta de acceso Tipo Description
identificación
id integer

Identificador único del elemento.

Elemento secundario disponible
childAvailable boolean

Indica si hay elementos secundarios disponibles.

Tipo de elemento
elementType integer

Tipo del elemento.

ListResponseUser

Elemento Response para enumerar usuarios.

Nombre Ruta de acceso Tipo Description
Contar
get_count integer

Número de usuarios de la respuesta de la lista.

Vínculo siguiente
get_nextLink string

Enlace a la siguiente página de resultados.

Importancia
get_value array of User

Matriz de elementos de usuario.

PublishingStatusInfo

Nombre Ruta de acceso Tipo Description
PublishingFailedException
publishingFailedException PublishingFailedException

Excepción producida cuando se produce un error en la publicación

publishingOutputDownloadInfo
publishingOutputDownloadInfo array of PublishingOutputDownloadInfo
Estado de publicación
publishingStatus string

Estado de publicación del recurso, los valores devueltos posibles se PUBLISHING_IN_PROGESS, PUBLISHING_FAILED, PUBLISHING_COMPLETED

PublishingFailedException

Excepción producida cuando se produce un error en la publicación

Nombre Ruta de acceso Tipo Description
Información adicional
additionalInfo array of string

Información adicional relacionada con la excepción

Throwable
cause Throwable

Clase base para excepciones y errores

Código de excepción
exceptionCode string

Código asociado a la excepción

Mensaje localizado
localizedMessage string

Mensaje localizado que describe la excepción

Message
message string

Mensaje que describe la excepción

stackTrace
stackTrace array of StackTraceElement
Suprimido
suppressed array of Throwable

Throwable

Clase base para excepciones y errores

Nombre Ruta de acceso Tipo Description
Causa
cause string

Causa de la iniciación

Mensaje localizado
localizedMessage string

Mensaje localizado que describe el valor de throwable

Message
message string

Mensaje que describe el valor de throwable

stackTrace
stackTrace array of StackTraceElement
Suprimida
suppressed array of string

Otros throwables suprimidos por este elemento throwable

StackTraceElement

Elemento que representa un marco de pila único

Nombre Ruta de acceso Tipo Description
Nombre de clase
className string

Nombre de la clase que contiene el punto de ejecución

Nombre de archivo
fileName string

Nombre del archivo que contiene el punto de ejecución

Número de línea
lineNumber integer

Número de línea del archivo que contiene el punto de ejecución

Nombre del método
methodName string

Nombre del método que contiene el punto de ejecución

Método nativo
nativeMethod boolean

Indica si el método es un método nativo

Grupo

Nombre Ruta de acceso Tipo Description
childDomainValues
childDomainValues array of DomainValue
Identificador de clase de usuario predeterminado
defaultUserClassId integer

Identificador de clase de usuario predeterminado para el grupo.

Borrado
deleted boolean

Indica si se elimina el grupo.

Identificador de dominio
domainId integer

Identificador del dominio al que pertenece el grupo.

Dirección de correo electrónico
emailAddress string

Dirección de correo electrónico asociada al grupo.

Tiene hijos
hasChildren boolean

Indica si el grupo tiene elementos secundarios.

identificación
id integer

El ID del grupo.

Está eliminado
isDeleted boolean

Indica si se elimina el grupo.

Nombre distintivo LDAP
ldapDistinguishedName string

Nombre distintivo en LDAP para el grupo.

Id. de perfil LDAP
ldapProfileId integer

Identificador de perfil LDAP para el grupo.

Identificadores de miembro
memberIds array of integer

Matriz de identificadores de miembro asociados al grupo.

Nombre
name string

Nombre del grupo.

Administrador de confianza nativo
nativeTrustee boolean

Indica si el grupo es un administrador de confianza nativo.

Referencia de origen
sourceReference string

Referencia de origen del grupo.

Usuario
user boolean

Indica si el grupo es un usuario.

entero

Este es el tipo de datos básico "entero".

cuerda / cadena

Este es el tipo de datos básico "string".