사용자 관계 유형 목록 조회

이 엔드포인트를 사용하여 데이터 오브젝트 유형의 사용자 관계에 유효한 rel_kind 값을 조회할 수 있습니다.

중요

데이터 오브젝트는 현재 얼리 액세스 단계입니다. 워크스페이스가 활성화되어야 데이터 오브젝트 API 키 권한이 설정 > API 키에 표시됩니다.

전제 조건

이 엔드포인트를 사용하려면 data_objects.read 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트는 데이터 오브젝트 읽기 버킷에 포함되며 기본값으로 분당 50회 요청으로 제한됩니다.

경로 매개변수

다음 표는 /data_objects/types/{type_name}/user_relationship_types 엔드포인트의 경로 매개변수를 나열하고 설명합니다.

쿼리 매개변수

다음 표는 /data_objects/types/{type_name}/user_relationship_types 엔드포인트의 쿼리 매개변수를 나열하고 설명합니다.

요청 예시

이 섹션에는 샘플 매개변수 페이로드와 샘플 cURL 요청이 포함되어 있습니다.

샘플 요청 페이로드

이 JSON 오브젝트를 요청 매개변수의 참조로 사용하세요.

1
2
3
4
5

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

샘플 cURL 요청

이 예시는 사용자를 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'

응답

이 섹션에는 샘플 성공 응답과 응답 필드가 포함되어 있습니다.

성공 응답 예시

상태 코드 200은 다음 응답 본문을 반환할 수 있습니다.

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은 현재 rel_kind와 동일합니다.

응답 매개변수

다음 표는 성공 응답의 필드를 나열하고 설명합니다.

오류

다음 표는 이 엔드포인트의 일반적인 오류와 해결 방법을 나열합니다.