오브젝트 관계 목록 조회

이 엔드포인트를 사용하여 하나의 오브젝트 앵커에서 관련 커스텀 오브젝트를 조회합니다.

중요

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

사전 요구 사항

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

사용량 제한

이 엔드포인트는 커스텀 오브젝트 읽기 버킷에 포함되며, 기본값으로 분당 50건의 요청으로 제한됩니다.

경로 매개변수

다음 표에는 /custom_objects/objects/{type_name}/{external_id}/object_relationships 엔드포인트의 경로 매개변수가 나열되어 있습니다.

쿼리 매개변수

다음 표에는 /custom_objects/objects/{type_name}/{external_id}/object_relationships 엔드포인트의 쿼리 매개변수가 나열되어 있습니다.

요청 예시

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

샘플 요청 페이로드

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

1
2
3
4
5
6
7
8
{
  "type_name": "account",
  "external_id": "acct-123",
  "anchor": "source",
  "rel_kind": "subaccount",
  "limit": 100,
  "offset": 0
}

샘플 cURL 요청

이 예시에서는 acct-123이 연결하는 subaccount 레코드를 조회하여 첫 번째 페이지의 결과를 반환합니다.

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123/object_relationships?anchor=source&rel_kind=subaccount&limit=100&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
17
18
{
  "items": [
    {
      "rel_kind": "subaccount",
      "to_custom_object": {
        "type_name": "account",
        "external_id": "acct-456",
        "attributes": { "name": "Child Account" }
      },
      "attributes": {}
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

anchor=target을 사용하면 관련 오브젝트가 from_custom_object로 반환됩니다.

응답 매개변수

다음 표에는 성공 응답의 필드가 나열되어 있습니다.

오류

다음 표에는 이 엔드포인트의 일반적인 오류와 해결 방법이 나열되어 있습니다.