오브젝트 관계 유형 목록

이 엔드포인트를 사용하면 주어진 앵커 방향에 대해 오브젝트 간 연결에 사용할 수 있는 관계 종류를 나열할 수 있습니다.

중요

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

전제 조건

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

사용량 제한

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

경로 매개변수

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

쿼리 매개변수

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

요청 예시

이 섹션에서는 샘플 매개변수 페이로드와 샘플 cURL 요청을 제공합니다.

샘플 요청 페이로드

요청 매개변수에 대한 참조로 다음 JSON 오브젝트를 사용합니다.

1
2
3
4
5
6

{
  "type_name": "account",
  "anchor": "source",
  "limit": 10,
  "offset": 0
}

샘플 cURL 요청

이 예시에서는 account 유형이 관계의 소스일 때 account 유형에 사용 가능한 오브젝트 관계 종류를 나열합니다.

1
2

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

응답

이 섹션에서는 성공 응답 샘플과 응답 필드를 제공합니다.

성공 응답 예시

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "items": [
    {
      "from_type_name": "account",
      "to_type_name": "account",
      "rel_kind": "subaccount",
      "display_name": "subaccount",
      "related_type_name": "account"
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 10
}

related_type_name은 선택한 anchor에 대한 관계의 반대편 유형입니다.

응답 매개변수

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

오류

다음 표는 이 엔드포인트에서 발생할 수 있는 일반적인 오류와 해결 방법을 나열합니다.