Listar tipos de relación de usuario

Utiliza este endpoint para listar los valores válidos de rel_kind para las relaciones de usuario en un tipo de objeto de datos.

Importante

Los objetos de datos se encuentran actualmente en acceso anticipado. Tu espacio de trabajo debe estar habilitado antes de que los permisos de clave de API de objetos de datos aparezcan en Configuración > Claves de API.

Requisitos previos

Para utilizar este endpoint, necesitas una clave de API con el permiso data_objects.read.

Límite de velocidad

Este endpoint se encuentra en el contenedor de lectura de objetos de datos con un límite predeterminado de 50 solicitudes por minuto.

Parámetros de ruta

La siguiente tabla enumera y describe los parámetros de ruta del endpoint /data_objects/types/{type_name}/user_relationship_types.

Parámetros de consulta

La siguiente tabla enumera y describe los parámetros de consulta del endpoint /data_objects/types/{type_name}/user_relationship_types.

Solicitud de ejemplo

Esta sección incluye una carga útil de parámetros de muestra y una solicitud cURL de muestra.

Carga útil de solicitud de muestra

Utiliza este objeto JSON como referencia para los parámetros de solicitud.

1
2
3
4
5

{
  "type_name": "account",
  "limit": 100,
  "offset": 0
}

Solicitud cURL de muestra

Este ejemplo lista los tipos de relación de usuario que puedes usar para vincular usuarios a registros de account.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account/user_relationship_types?limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Respuesta

Esta sección incluye una respuesta exitosa de muestra y los campos de la respuesta.

Ejemplo de respuesta exitosa

El código de estado 200 podría devolver el siguiente cuerpo de respuesta.

1
2
3
4
5
6
7
8
9
10

{
  "items": [
    { "rel_kind": "account_user", "display_name": "account_user" }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

display_name actualmente coincide con rel_kind.

Parámetros de respuesta

La siguiente tabla enumera y describe los campos en una respuesta exitosa.

Errores

La siguiente tabla enumera los errores comunes de este endpoint y cómo resolverlos.