Skip to main content

Puntos de conexión de colecciones

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

Crear una nueva 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 grupo de usuarios a una colección

Recuperar un registro de colección

Recuperar registros de todas las colecciones

Actualizar una colección existente

Actualizar los permisos de usuario de una colección

Actualizar los permisos de grupo de usuarios de una 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 grupo de usuarios 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 nueva colección

Para crear una colección, utiliza el punto de conexión POST {baseURL}/v3/collections .

Nota

Solo los administradores pueden usar este punto de conexión de la API. El usuario de la API autenticado debe tener el permiso “Crear colecciones” para usar este punto de conexión; de lo contrario, se devolverá el error 401 No autorizado.

Parámetros

  • contract (cuerpo): para crear una colección, se requiere el parámetro contract. Especifica lo siguiente para crear una colección:

    • name (cadena): obligatorio. Especifica el nombre de una 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 existente, utiliza el punto de conexión POST {baseURL}/v3/collections/{collectionId}/users .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

082A8515AB7ADDAAD5B04255CF2AE567.png

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección a la que agregar un usuario.

  • addUsersContract (cuerpo): obligatorio. Ingresa información sobre los usuarios y sus permisos. Especifica lo siguiente para agregar usuarios a una colección:

    • userId (cadena): obligatorio. Especifica el ID de un usuario que desees agregar a una colección.

    • expirationDate (cadena): opcional. Especifica la fecha de caducidad para que el usuario forme parte de esta colección. Ingresa la fecha y la hora en formato ISO8601.

    • collectionsPermissions (cuerpo):

      • isAdmin (booleano): obligatorio. Especifica si el usuario debe ser administrador de esta colección.

      • canAddAssets (booleano): obligatorio. Especifica si el usuario puede agregar activos a la colección.

      • canUpdateAssets (booleano): obligatorio. Especifica si el usuario puede actualizar los activos de la colección.

      • canRemoveAssets (booleano): obligatorio. Especifica si el usuario puede quitar activos de la colección.

      • canAddUsers (booleano): opcional. Especifica si el usuario puede agregar otros usuarios a la colección.

      • canRemoveUsers (booleano): opcional. Especifica si el usuario puede quitar usuarios de la 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=61d80f862835728c94328082' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true' \ --data-urlencode 'expirationDate=2007-08-17T19:18:11.924Z'

Agregar un insight a una colección

Para agregar un insight a una colección existente, utiliza el punto de conexión POST {baseURL}/v3/collections/{collectionId}/insights .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección a la que agregar un insight.

  • contract (cuerpo): obligatorio. Ingresa información sobre el insight. Especifica lo siguiente:

    • insightId (cadena): obligatorio. Especifica el ID de insight que deseas agregar a la 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 una colección existente, utiliza el punto de conexión POST {baseURL}/v3/collections/{collectionId}/schedules .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección a la que agregar una programación.

  • contract (cuerpo): obligatorio. Ingresa información sobre la programación. Especifica lo siguiente:

    • scheduleId (cadena): obligatorio. Especifica el ID de programación que deseas agregar a la 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 'scheduleId=61d80f334528377728c94328082'

Agregar un flujo de trabajo a una colección

Para agregar un flujo de trabajo a una colección existente, utiliza el punto de conexión POST {baseURL}/v3/collections/{collectionId}/workflows .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección a la que agregar un insight.

  • contract (cuerpo): obligatorio. Ingresa información sobre los usuarios y sus permisos. Especifica lo siguiente:

    • workflowId (cadena): obligatorio. Especifica el ID de flujo de trabajo que deseas agregar a la 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 grupo de usuarios a una colección

Para agregar un grupo de usuarios a una colección existente, utiliza el punto de conexión POST {baseURL}/v3/collections/{collectionId}/userGroups .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección a la que agregar un grupo de usuarios.

  • addUserGroupsContract (cuerpo): obligatorio. Ingresa información sobre el grupo de usuarios y sus permisos. Especifica lo siguiente:

    • userGroupId (cadena): obligatorio. Especifica el ID de un grupo de usuarios que deseas agregar a una colección.

    • expirationDate (cadena): opcional. Especifica la fecha de caducidad para que el grupo de usuarios forme parte de esta colección. Ingresa la fecha y la hora después de la cual se creó el usuario en formato ISO8601.

    • collectionsPermissions (cuerpo): obligatorio.

      • isAdmin (booleano): opcional. Especifica si los miembros del grupo de usuarios deben ser administradores de esta colección. El valor predeterminado es falso.

      • canAddAssets (booleano): opcional. Especifica si los miembros del grupo de usuarios pueden agregar activos a la colección. El valor predeterminado es falso.

      • canRemoveAssets (booleano): opcional. Especifica si los miembros del grupo de usuarios pueden quitar activos de la colección. El valor predeterminado es falso.

      • canUpdateAssets (booleano): opcional. Especifica si los miembros del grupo de usuarios pueden actualizar los activos de la colección. El valor predeterminado es falso.

      • canAddUsers (booleano): opcional. Especifica si los miembros del grupo de usuarios pueden agregar otros usuarios a la colección. El valor predeterminado es falso.

      • canRemoveUsers (booleano): obligatorio. Especifica si los miembros del grupo de usuarios pueden quitar a otros usuarios de la colección. El valor predeterminado es falso.

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' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=false' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=false' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Recuperar un registro de colección

Para recuperar detalles sobre una colección existente, utiliza el punto de conexión GET {baseURL}/v3/collections/{collectionId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para obtener la información sobre la colección.

Ejemplo de solicitud: cURL

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

Recuperar registros de todas las colecciones

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

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • view (cadena): opcional. Se puede dejar sin un valor. Puedes elegir entre los siguientes valores: “Predeterminado” y “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/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Actualizar una colección existente

Para actualizar el nombre o propietario de una colección existente, utiliza el punto de conexión PUT {baseURL}/v3/collections/{collectionId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • updateCollectionContract (cuerpo): obligatorio. Ingresa información sobre el propietario de la colección que deseas cambiar. Especifica lo siguiente:

    • name (cadena): obligatorio. Ingresa el nuevo nombre de la colección.

    • ownerId (cadena): obligatorio. Ingresa el ID del nuevo 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=61db388fc565144387d45086'

Actualizar los permisos de usuario de una colección

Para actualizar los permisos de usuario dentro de una colección existente, utiliza el punto de conexión PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions .

Nota

Solo los administradores pueden usar este punto de conexión de la API. En el caso de las instancias de Server configuradas con autenticación de Windows, proporciona el SID de Active Directory para el parámetro userId.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • userId (cadena): obligatorio. Ingresa un ID de usuario para el que deseas cambiar los permisos.

  • updatePermissionsContract (cuerpo): obligatorio. Ingresa el ID de usuario para el que deseas cambiar los permisos. Especifica lo siguiente:

    • expirationDate (fecha): obligatorio. Especifica la fecha de caducidad de un usuario.

    • collectionsPermissions (cuerpo): obligatorio. Ingresa el ID de usuario del nuevo propietario. Especifica lo siguiente:

      • isAdmin (booleano): obligatorio. Especifica si el usuario debe ser administrador de esta colección.

      • canAddAssets (booleano): obligatorio. Especifica si el usuario puede agregar activos a la colección.

      • canRemoveAssets (booleano): obligatorio. Especifica si el usuario puede quitar activos de la colección.

      • canUpdateAssets (booleano): obligatorio. Especifica si el usuario puede actualizar los activos de la colección.

      • canAddUsers (booleano): obligatorio. Especifica si el usuario puede agregar otros usuarios a la colección.

      • canRemoveUsers (booleano): obligatorio. Especifica si el usuario puede quitar a otros usuarios de la 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' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Actualizar los permisos de grupo de usuarios de una colección

Para actualizar los permisos de grupos de usuarios dentro de una colección existente, utiliza el punto de conexión PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • userGroupId (cadena): obligatorio. Ingresa un ID de grupo de usuarios para el que deseas cambiar los permisos.

  • updatePermissionsContract (cuerpo): obligatorio. Ingresa el ID de grupo de usuarios para el que deseas cambiar los permisos. Especifica lo siguiente:

    • expirationDate (fecha): opcional. Especifica la fecha de caducidad de un grupo de usuarios.

    • collectionsPermissions (cuerpo): obligatorio. Especifica lo siguiente:

      • isAdmin (booleano): obligatorio. Especifica si los miembros del grupo de usuarios deben ser administradores de esta colección.

      • canAddAssets (booleano): obligatorio. Especifica si los miembros del grupo de usuarios pueden agregar activos a la colección.

      • canRemoveAssets (booleano): obligatorio. Especifica si los miembros del grupo de usuarios pueden quitar activos de la colección.

      • canUpdateAssets (booleano): obligatorio. Especifica si los miembros del grupo de usuarios pueden actualizar los activos de la colección.

      • canAddUsers (booleano): obligatorio. Especifica si los miembros del grupo de usuarios pueden agregar otros usuarios a la colección.

      • canRemoveUsers (booleano): obligatorio. Especifica si los miembros del grupo de usuarios pueden quitar usuarios de la 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' \ --data-urlencode 'canRemoveAssets=false' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Quitar un usuario de una colección

Para quitar un usuario de una colección existente, utiliza el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/users/{userId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • userId (cadena): obligatorio. Ingresa un ID de usuario que desees quitar de la colección.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar un flujo de trabajo de una colección

Para quitar un flujo de trabajo de una colección existente, utiliza el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • appId (cadena): obligatorio. Ingresa un ID de flujo de trabajo que desees quitar de la colección.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/workflows/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar un insight de una colección

Para quitar un insight de una colección existente, utiliza el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/insights/{insightId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • insightId (cadena): obligatorio. Ingresa un ID de insight que desees quitar de la colección.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/insights/61db388fc565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar una programación de una colección

Para quitar una programación de una colección existente, utiliza el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • scheduleId (cadena): obligatorio. Ingresa un ID de programación que desees quitar de la colección.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/schedules/61db3777c565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Quitar un grupo de usuarios de una colección

Para quitar un grupo de usuarios de una colección existente, utiliza el punto de conexión DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • userGroupId (cadena): obligatorio. Ingresa un ID de grupo de usuarios que desees quitar de la colección.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61dc063d9938fe43b5e8fc80' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Eliminar una colección

Para eliminar una colección, utiliza el punto de conexión DELETE {baseURL}/v3/collections/{collectionId} .

Nota

Solo los administradores pueden usar este punto de conexión de la API.

Parámetros

  • collectionId (cadena): obligatorio. Ingresa un ID de colección para especificar la colección que deseas actualizar.

  • forceDelete (booleano): opcional. Selecciona si deseas forzar la eliminación de una colección en caso de que esta colección tenga enlaces a otros objetos, como usuarios, grupos, flujos de trabajo, insights y programaciones. Si deseas eliminar la colección y limpiar todos los enlaces, establece el parámetro forceDelete en verdadero. Si no se selecciona, el valor predeterminado es falso. Este parámetro se utiliza para protegerse contra una llamada errante.

Ejemplo de solicitud: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/253fcf0b10204dc085f07bdf1b40e759?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relaciones entre objetos

Si creas una colección, puedes utilizar los objetos creados de la siguiente manera:

Objeto creado: “ id ” (por ejemplo, “id”: “7917969784f84bd09442f66996ecb8f3”)

Puedes usarlo como:

Ejemplos de solicitudes de Postman

POST /v3/collections

Use POST /v3/collections endpoint.

GET /v3/collections/

Use GET /v3/collections endpoint.

PUT /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 .