데이터 객체 유형 가져오기

이 엔드포인트를 사용하여 하나의 데이터 객체 유형과 해당 스키마 정의를 반환할 수 있습니다.

중요

데이터 객체는 현재 얼리 액세스 중입니다. 데이터 객체 API 키 권한이 설정 > API 키에 표시되려면 워크스페이스가 활성화되어야 합니다.

전제 조건

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

사용량 제한

이 엔드포인트는 데이터 객체 읽기 버킷에 속하며, 기본값으로 분당 50건의 요청이 제한됩니다.

경로 매개변수

다음 표에는 /data_objects/types/{type_name} 엔드포인트의 경로 매개변수가 나열되어 있으며 각 매개변수에 대한 설명이 포함되어 있습니다.

요청 예시

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

샘플 요청 페이로드

이 요청의 경로 매개변수에 대한 참조로 다음 JSON 객체를 사용하세요.

1
2
3

{
  "type_name": "account"
}

샘플 cURL 요청

이 예시에서는 account 데이터 객체 유형의 정의를 가져옵니다.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/types/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

응답

이 섹션에는 성공 응답 예시와 응답 필드가 포함되어 있습니다.

성공 응답 예시

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

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

{
  "data_object_type": {
    "type_name": "account",
    "metadata": { "display_name_source": "name" },
    "schema_def": {
      "type": "object",
      "properties": {
        "name": { "type": "string", "title": "Name" },
        "industry": { "type": "string", "title": "Industry" },
        "renewal_date": { "type": "string", "format": "date-time", "title": "Renewal date" }
      },
      "required": ["name"]
    }
  }
}

schema_def는 허용되는 객체 필드를 설명합니다. 이 응답 스키마는 설명용이지만, 쓰기 작업 시에는 선언되지 않은 필드가 여전히 거부됩니다.

응답 매개변수

다음 표에는 성공 응답의 필드가 나열되어 있으며 각 필드에 대한 설명이 포함되어 있습니다.

오류

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