데이터 오브젝트 유형 목록

이 엔드포인트를 사용하여 워크스페이스의 데이터 오브젝트 유형을 나열할 수 있습니다.

중요

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

필수 조건

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

사용량 제한

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

쿼리 매개변수

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

요청 예시

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

샘플 요청 페이로드

이 요청의 쿼리 매개변수에 대한 참조로 다음 JSON 오브젝트를 사용하세요.

1
2
3
4
5

{
  "search_term": "acc",
  "limit": 2,
  "offset": 0
}

샘플 cURL 요청

이 예시에서는 검색어 acc와 일치하는 데이터 오브젝트 유형을 나열하며, 페이지당 두 개의 결과를 반환합니다.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types?search_term=acc&limit=2&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

{
  "items": [
    {
      "type_name": "account",
      "metadata": { "display_name_source": "name" }
    },
    {
      "type_name": "contact",
      "metadata": {}
    }
  ],
  "total_count": 2,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

metadata.display_name_source는 해당 유형에 표시 이름 필드가 구성되어 있을 때 표시됩니다.

응답 매개변수

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

오류

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