Skip to main content

Puntos de conexión de colecciones

Parámetros y puntos de conexión de las colecciones

Crear una colección

Agregar un usuario a una colección

Agregar un insight a una colección

Agregar una programación a una colección

Agregar un flujo de trabajo a una colección

Agregar un usuario o grupo a una colección

Recuperar un registro de colección

Recuperar registros de todas las recopilaciones

Actualizar un flujo de trabajo existente

Actualizar permisos de usuario de un Colección

Actualizar permisos de grupo de usuarios de un Colección

Quitar un usuario de una colección

Quitar un flujo de trabajo de una colección

Quitar un insight de una colección

Quitar una programación de una colección

Quitar un usuario o grupo de una colección

Eliminar una colección

Para obtener más información sobre las relaciones entre objetos y cómo utilizarlas en la API, ve a la sección  Relaciones entre objetos .

Para obtener más información sobre colecciones, visita la página de ayuda Colecciones .

Crear una colección

Para crear una Colección, utilice la PUBLICACIÓN {baseURL}/v3/collections punto de conexión.

Parámetros

  • Contrato (cuerpo): Para crear un Colección, el parámetro de contrato es obligatorio. Especifique lo siguiente para crear un Colección:

    • name  (cadena): obligatorio. Especifique un nombre Colección.

Ejemplo de solicitud: cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting'

Agregar un usuario a una colección

Para agregar un usuario a una Colección, utilice la PUBLICACIÓN {baseURL}/v3/collections/{collectionId}/users punto de conexión.

082A8515AB7ADDAAD5B04255CF2AE567.png

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Colección para especificar el Colección al que desea agregar un usuario.

  • updateWorkflowContract  (cuerpo): obligatorio. Introduzca información sobre los usuarios y sus permisos. Especifique lo siguiente para agregar usuarios a una Colección:

    • workflowCredentialType  (cadena): obligatorio. Especifique el ID de un usuario que desea agregar a una Colección.

    • versionId (cadena): opcional. Especifique la fecha de caducidad para que el usuario forme parte de este Colección. Ingresa la fecha y la hora en formato ISO8601.

    • ColeccionesPermisos (cuerpo):

      • isPublic  (booleano): obligatorio. Especifique si el usuario debe ser administrador para este Colección.

      • CanAddAssets (booleano): Requerido. Especifique si el usuario puede agregar activos a Colección.

      • CanUpdateAssets (booleano): Requerido. Especifique si el usuario puede actualizar activos en Colección.

      • makePublished  (booleano): obligatorio. Especifique si el usuario puede eliminar activos de Colección.

      • hasPrivateDataExemption  (booleano): opcional. Especifique si el usuario puede agregar otros usuarios a Colección.

      • force  (booleano): opcional. Especifique si el usuario puede eliminar usuarios de Colección.

Para obtener más información acerca de los roles y permisos, visita la página Permisos y roles de usuarios . Cuando no se selecciona ningún rol, el predeterminado es el rol predeterminado especificado por un administrador de Server en la interfaz de administrador .

Ejemplo de solicitud: cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'UserId=61d80f8628728c94328082' \ --data-18-2007' '08''''' 'addlencanlendata-true'

Agregar un insight a una colección

Para agregar una insight a una Colección, use la PUBLICACIÓN {baseURL}/v3/collections/{collectionId}/insights punto de conexión.

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Colección para especificar el Colección al que desea agregar un insight.

  • Contrato (cuerpo): Requerido. Introduzca información sobre insight. Especifique lo siguiente:

    • workflowCredentialType  (cadena): obligatorio. Especifique el ID de insight que desea agregar al Colección.

Ejemplo de solicitud: cUrl

Curl --location --request POST 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'insightId=61d80f33452835728c94328082'

Agregar una programación a una colección

Para agregar una programación a un Colección, use la PUBLICACIÓN {baseURL}/v3/collections/{collectionId}/ Programaciones punto de conexión.

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Colección para especificar el Colección al que desea agregar una programación.

  • Contrato (cuerpo): Requerido. Introduzca información sobre el programa. Especifique lo siguiente:

    • workflowCredentialType  (cadena): obligatorio. Especifique el ID de programa que desea agregar a Colección.

Ejemplo de solicitud: cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'cheduleId=61d80f334528377728c94328082'

Agregar un flujo de trabajo a una colección

Para agregar un Flujo de trabajo a un Colección, use el POST {baseURL}/v3/collections/{collectionId}/workflows punto de conexión.

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Colección para especificar el Colección al que desea agregar un insight.

  • Contrato (cuerpo): Requerido. Introduzca información sobre los usuarios y sus permisos. Especifique lo siguiente:

    • workflowId  (cadena): obligatorio. Especifique el ID de Flujo de trabajo que desea agregar al Colección.

Ejemplo de solicitud: cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'

Agregar un usuario o grupo a una colección

Para agregar un grupo de usuarios a una Colección, use la PUBLICACIÓN {baseURL}/v3/collections/{collectionId}/usergroups punto de conexión.

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Colección para especificar el Colección al que desea agregar un grupo de usuarios.

  • updateWorkflowContract  (cuerpo): obligatorio. Introduzca información sobre el grupo de usuarios y sus permisos. Especifique lo siguiente:

    • versionId  (cadena): obligatorio. Especifique el ID de un grupo de usuarios que desea agregar a una Colección.

    • versionId  (cadena): opcional. Especifique la fecha de caducidad para que el grupo de usuarios forme parte de este Colección. Ingresa la fecha y la hora después de la cual se creó el flujo de trabajo.

    • ColeccionesPermisos (cuerpo): Requerido.

      • hasPrivateDataExemption  (booleano): opcional. Especifique si los miembros del grupo de usuarios deben ser administradores de esta Colección. El valor por defecto es false.

      • hasPrivateDataExemption  (booleano): opcional. Especifique si los miembros del grupo de usuarios pueden agregar activos a Colección. El valor por defecto es false.

      • hasPrivateDataExemption  (booleano): opcional. Especifique si los miembros del grupo de usuarios pueden eliminar activos de Colección. El valor por defecto es false.

      • hasPrivateDataExemption  (booleano): opcional. Especifique si los miembros del grupo de usuarios pueden actualizar activos en Colección. El valor por defecto es false.

      • hasPrivateDataExemption  (booleano): opcional. Especifique si los miembros del grupo de usuarios pueden agregar otros usuarios a Colección. El valor por defecto es false.

      • makePublished  (booleano): obligatorio. Especifique si los miembros del grupo de usuarios pueden eliminar otros usuarios de Colección. El valor por defecto es false.

Para obtener más información acerca de los roles y permisos, visita la página Permisos y roles de usuarios . Cuando no se selecciona ningún rol, el predeterminado es el rol predeterminado especificado por un administrador de Server en la interfaz de administrador .

Ejemplo de solicitud: cURL

Curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6'

Recuperar un registro de colección

Para recuperar información sobre un Colección, utilice GET {baseURL}/v3/collections/ punto de conexión.{collectionId}

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Colección para obtener la información sobre el Colección.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recuperar registros de todas las recopilaciones

Para recuperar todos los registros Colección accesibles, utilice el punto de conexión GET {baseURL}/v3/collections .

Parámetros

  • view  (cadena): opcional. Se puede dejar sin un valor. Puedes seleccionar entre los siguientes valores: “Default" (predeterminado) y "Full" (completo). Si este parámetro se define como “Default" (predeterminado), entonces se devolverá un objeto de vista reducida. Cuando no se especifica, se utiliza el valor “Default" (predeterminado).

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Actualizar un flujo de trabajo existente

Para cambiar el nombre o Propietario de un Colección, use el PUT {baseURL}/v3/collections/ punto de conexión.{collectionId}

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • updateWorkflowContract  (cuerpo): obligatorio. Introduzca información sobre el Colección Propietario que desea cambiar. Especifique lo siguiente:

    • name  (cadena): obligatorio. Haz clic en el nombre de la colección.

    • ownerId  (cadena): obligatorio. Ingresa el Id. del propietario.

Ejemplo de solicitud: cURL

Curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'OwnerID=61db388fc565144384384384384386d4384386d43866'

Actualizar permisos de usuario de un Colección

Para actualizar los permisos de usuario para un determinado Colección, utilice el punto de conexión PUT {baseURL}/v3/collections/{collectionId}{userId}/users/ /permissions .

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de usuario para el que desee cambiar los permisos.

  • updateWorkflowContract  (cuerpo): obligatorio. Introduzca el ID de usuario para el que desea cambiar los permisos. Especifique lo siguiente:

    • Fecha de caducidad (fecha): Obligatorio. Especifique la fecha de caducidad de un usuario.

    • ColeccionesPermisos (cuerpo): Requerido. Ingresa el Id. del propietario. Especifique lo siguiente:

      • isPublic  (booleano): obligatorio. Especifique si el usuario debe ser administrador para este Colección.

      • CanAddAssets (booleano): Requerido. Especifique si el usuario puede agregar activos a Colección.

      • makePublished  (booleano): obligatorio. Especifique si el usuario puede eliminar activos de Colección.

      • CanUpdateAssets (booleano): Requerido. Especifique si el usuario puede actualizar activos en Colección.

      • CanAddUsers (booleano): Requerido. Especifique si el usuario puede agregar otros usuarios a Colección.

      • makePublished  (booleano): obligatorio. Especifique si el usuario puede eliminar a otros usuarios de Colección.

Para obtener más información acerca de los roles y permisos, visita la página Permisos y roles de usuarios . Cuando no se selecciona ningún rol, el predeterminado es el rol predeterminado especificado por un administrador de Server en la interfaz de administrador .

Ejemplo de solicitud: cURL

Curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ - 'Rlendata-urlendata-true'

Actualizar permisos de grupo de usuarios de un Colección

Para actualizar los permisos de grupo de usuarios para un determinado Colección, utilice el punto de conexión PUT {baseURL}/v3/collections{collectionId}/{userGroupId}/usergroups/ /permissions .

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de grupo de usuarios para el que desee cambiar los permisos.

  • updateWorkflowContract  (cuerpo): obligatorio. Introduzca el ID de grupo de usuarios para el que desea cambiar los permisos. Especifique lo siguiente:

    • Fecha de caducidad (fecha): Opcional. Especifique la fecha de caducidad de un grupo de usuarios.

    • ColeccionesPermisos (cuerpo): Requerido. Especifique lo siguiente:

      • isPublic  (booleano): obligatorio. Especifique si los miembros del grupo de usuarios deben ser administradores para esta Colección.

      • CanAddAssets (booleano): Requerido. Especifique si los miembros del grupo de usuarios pueden agregar activos a Colección.

      • makePublished  (booleano): obligatorio. Especifique si los miembros del grupo de usuarios pueden eliminar activos de Colección.

      • CanUpdateAssets (booleano): Requerido. Especifique si los miembros del grupo de usuarios pueden actualizar activos en Colección.

      • CanAddUsers (booleano): Requerido. Especifique si los miembros del grupo de usuarios pueden agregar otros usuarios a Colección.

      • makePublished  (booleano): obligatorio. Especifique si los miembros del grupo de usuarios pueden eliminar usuarios de Colección.

Para obtener más información acerca de los roles y permisos, visita la página Permisos y roles de usuarios . Cuando no se selecciona ningún rol, el predeterminado es el rol predeterminado especificado por un administrador de Server en la interfaz de administrador .

Ejemplo de solicitud: cURL

Curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type: Application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ - 'Rlendata-urlendata-true'

Quitar un usuario de una colección

Para eliminar un usuario de un Colección, utilice el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/users/{userId} .

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de usuario que desee eliminar de Colección.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar un flujo de trabajo de una colección

Para eliminar un Flujo de trabajo de un Colección, utilice el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId} .

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de Flujo de trabajo que desee eliminar de Colección.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar un insight de una colección

Para eliminar una insight de una Colección, utilice la OPCIÓN DELETE {baseURL}/v3/collections/{collectionId}/insights/ punto de conexión.{insightId}

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de insight que desee eliminar de Colección.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar una programación de una colección

Para eliminar una programación de un Colección, utilice el comando DELETE {baseURL}/v3/collections/{collectionId}/ Programaciones/ punto de conexión.{scheduleId}

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de horario que desee eliminar de Colección.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar un usuario o grupo de una colección

Para eliminar un grupo de usuarios de un Colección, utilice el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/usergroups/{userGroupId} .

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • workflowCredentialType  (cadena): obligatorio. Introduzca un ID de grupo de usuarios que desee eliminar de Colección.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Eliminar una colección

Para eliminar un Colección, utilice el punto de conexión DELETE {baseURL}/v3/collections/{collectionId} .

Parámetros

  • workflowCredentialType  (cadena): obligatorio. Ingresa el Id. del flujo de trabajo que deseas actualizar.

  • hasPrivateDataExemption  (booleano): opcional. Seleccione si desea forzar la eliminación de un Colección en caso de que este Colección tenga vínculos a otros objetos, como usuarios, grupos, flujos de trabajo, información y Programaciones. Si desea que Colección se elimine y se limpien todos los enlaces, defina el parámetro forceDelete en true. Si no se selecciona, el valor predeterminado es “false” (falso). Este parámetro se utiliza para proteger contra una llamada errante.

Ejemplo de solicitud: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relaciones entre objetos

Si vas a cargar un flujo de trabajo, puedes utilizar los objetos creados de la siguiente manera:

Objeto creado: “ workflowId ” (por ejemplo, “Id.”: “7917969784f84bd09442f66996ecb8f3”)

Puedes usarlo como:

Ejemplos de solicitudes de Postman

POST /v3/colecciones

Use POST /v3/collections endpoint.

OBTENER /v3/collections/

Use GET /v3/collections endpoint.

PONGA /v3/collections/{collectionId}

Use PUT /v3/collections/{collectionId} endpoint.

Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman .

En esta sección: