Saltar al contenido principal
PATCH
Update asset group

Descripción general

Cambia el nombre de un grupo de Assets (activos digitales: URL, direcciones, perfiles, apps, etc.) existente. Este endpoint te permite actualizar el nombre visible de un grupo que pertenece a tu organización. Todos los assets asignados a este grupo seguirán asignados después del cambio de nombre.

Inicio rápido

Autenticación

Incluye tu clave de API en el encabezado X-API-KEY:

Solicitud de ejemplo

Parámetros de ruta

Cuerpo de la solicitud

Respuesta

Respuesta exitosa

Campos de la respuesta

Respuestas de error

400 Bad Request

Se devuelve cuando la solicitud tiene un formato incorrecto o falla la validación:

401 Unauthorized

Se devuelve cuando la clave de API falta, no es válida o no tiene acceso a la organización:

403 Forbidden

Se devuelve cuando el grupo no pertenece a tu organización:

404 Not Found

Se devuelve cuando el grupo no existe:

409 Conflict

Se devuelve cuando ya existe un grupo con el nuevo nombre:

Buenas prácticas

Validación antes de renombrar

Verifica si ya existe un grupo con el nombre de destino:

Renombrado masivo con prefijo o sufijo

Agrega un prefijo o un sufijo a varios grupos:

Registro de auditoría

Registra los cambios de nombre de los grupos con fines de auditoría:

Casos de uso

Estandarizar la convención de nombres

Renombra los grupos para que sigan una convención de nombres uniforme:

Migrar la estructura de grupos

Renombra los grupos como parte de una migración de estructura:

Renombrado interactivo

Ofrece una interfaz interactiva para renombrar:

Mensajes de error comunes

Notas

  • Los nombres de los grupos deben ser únicos dentro de tu organización
  • Los nombres distinguen entre mayúsculas y minúsculas al verificar que sean únicos
  • Todos los assets asignados al grupo siguen asignados después del cambio de nombre
  • La organización se determina automáticamente a partir de tu clave de API
  • El ID del grupo debe coincidir en la ruta de la URL y en el cuerpo de la solicitud
  • Renombrar un grupo no afecta las asignaciones de assets ni los metadatos de los assets
  • La cantidad de assets del grupo no se ve afectada por las operaciones de renombrado

Autorizaciones

X-API-KEY
string
header
requerido

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Parámetros de ruta

groupId
integer
requerido

ID of the group to update

Rango requerido: x > 0

Cuerpo

application/json

Update an asset group

Rename an existing asset group.

name
string
requerido

New name for the group

Required string length: 1 - 255

Respuesta

Successful response

Updated group

id
number
requerido

Group ID

name
string
requerido

Updated group name