RCS Biz Center

컴포넌트 목록 조회

Request

레이아웃 등록/수정 시 사용 가능한 컴포넌트 목록을 조회 합니다.

get

레이아웃 등록/수정 시 사용 가능한 컴포넌트 목록을 조회 합니다. 컴포넌트 별 상세 내역이 제공되므로 별도의 컴포넌트별 상세 조회 API는 제공하지 않습니다.

  • 계정 권한: 대행사

Authorizations
Query parameters
offsetintegerOptional

시작 offset 번호(default: 0) 입니다.

Default: 0
limitinteger · min: 100 · max: 1000Optional

minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'

Default: 100
get
GET /api/1.1/baselayout/component HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

Response

필드명
타입
길이
필수여부
기본값
설명

result

array<object>

O

컴포넌트 정보 객체입니다.

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

pagination

object

O

전체 건수와 페이징 조건을 제공합니다.

links

object

O

이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명
타입
길이
필수여부
기본값
설명

componentId

string

40

컴포넌트 ID 입니다.

componentName

string

40

컴포넌트 이름 입니다.

iconImgFileUrl

string

1000

컴포넌트 모양을 아이콘으로 표현한 이미지 파일 주소입니다.

status

string

컴포넌트의 사용 가능 여부, 범위를 표시합니다.

  • public: 레이아웃 등록/수정 시 사용 가능한 컴포넌트 입니다.

  • private: RBC에서 특정 케이스별 추가하는 컴포넌트로 레이아웃 등록/수정 시 별도 사용할 수 없습니다.

  • tpl: 템플릿에서 사용되는 컴포넌트로 레이아웃 등록/수정 시 사용할 수 없습니다.

  • disable: 사용할 수 없는 컴포넌트 입니다. 제공 중이던 컴포넌트가 사용 중지된 경우 설정됩니다.

headerYn

string

레이아웃의 Header 영역 내 사용 가능 여부입니다.

  • Y: 가능

  • N: 불가능

bodyYn

string

레이아웃의 Body 영역 내 사용 가능 여부입니다.

  • Y: 가능

  • N: 불가능

footerYn

string

레이아웃의 footer 영역 내 사용 가능 여부입니다.

  • Y: 가능

  • N: 불가능

options

object

레이아웃 사용 시 컴포넌트에 적용될 수 있는 옵션입니다. 옵션 지정이 가능한 경우 표기됩니다.

groupComponentId

string

컴포넌트 그룹 ID 입니다. 동일한 컴포넌트 그룹ID를 갖는 컴포넌트는 레이아웃의 body 영역에서 함께 사용될 수 없습니다.

options - object(0)

필드명
타입
길이
필수여부
기본값
설명

leftAlign

string

left

좌측 컬럼(열) 전체의 글자 정렬 위치를 설정합니다.

  • left : 좌측 정렬

  • right : 우측 정렬

  • center : 중앙 정렬

rightAlign

string

right

우측 컬럼(열) 전체의 글자 정렬 위치를 설정합니다.

  • left : 좌측 정렬

  • right : 우측 정렬

  • center : 중앙 정렬

leftTextStyle

string

normal

좌측 컬럼(열)에 입력되는 글자 스타일을 지정합니다.

  • normal : 기본 스타일

  • bold : bold 스타일 적용

rightTextStyle

string

normal

우측 컬럼(열)에 입력되는 글자 스타일을 지정합니다.

  • normal : 기본 스타일

  • bold : bold 스타일 적용

maxCount

integer

5

테이블의 행 개수를 지정합니다. 정의된 숫자 이외에는 지정할 수 없습니다.

  • 5 : 5행

  • 10 : 10행

Table / StyleTable등 테이블 컴포넌트의 옵션 정보 객체 입니다.

options - object(1)

필드명
타입
길이
필수여부
기본값
설명

color

string

버튼의 색상 설정 옵션입니다. 버튼의 색상은 브랜드 정보에서 지정한 templateColor 컬러 Hex 값과 동일해야 합니다. 빈값 지정 시 기본 버튼 컬러로 적용되며, 지정된 컬러 Hex 값이 templateColor의 값과 다르면 templateColor로 강제 설정됩니다.

VButton / HButton 등 버튼 컴포넌트의 옵션 정보 객체 입니다.

options - object(2)

필드명
타입
길이
필수여부
기본값
설명

ctlrViewAll

boolean

true

컴포넌트 단위의 viewAll(모두보기) 활성화 여부를 지정합니다.

  • true: 컴포넌트 viewAll(모두보기) 활성화

  • false: 컴포넌트 viewAll(모두보기) 비활성화

viewAll

integer

150

viewAll(모두보기) 접힘 글자수 기준값을 지정합니다.

  • 유효값: 150(default), 300

  • 유효값 이외 수치가 입력되는 경우 defualt로 처리됩니다.

viewAll(모두보기) 설정을 포함하는 컴포넌트의 옵션 정보 객체 입니다.

pagination - object

필드명
타입
길이
필수여부
기본값
설명

total

integer

O

전체건수

offset

integer

O

0

조회 기준 위치

limit

integer

O

100

페이지 당 조회 건수

links - object

필드명
타입
길이
필수여부
기본값
설명

prev

string

O

이전페이지URL

next

string

O

다음페이지URL

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "componentId": "CP-Banner",
            "componentName": "배너",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-Banner/LT-CP-Banner-O17l_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "BannerGroup"
        },
        {
            "componentId": "CP-Description",
            "componentName": "디스크립션",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-Description/LT-CP-Description-qh7e_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "DescriptionGroup"
        },
        {
            "componentId": "CP-HButton",
            "componentName": "좌우버튼",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-HButton/LT-CP-HButton-Kpy2_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": {
                "color": "#1e1e1e"
            },
            "groupComponentId": "ButtonGroup"
        },
        {
            "componentId": "CP-ImageHorizontal",
            "componentName": "가로형이미지",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-ImageHorizontal/LT-CP-ImageHorizontal-535b_1.png",
            "headerYn": "Y",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "ImageGroup"
        },
        {
            "componentId": "CP-ImageSquare",
            "componentName": "정형이미지",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-ImageSquare/LT-CP-ImageSquare-N2le_1.png",
            "headerYn": "Y",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "ImageGroup"
        },
        {
            "componentId": "CP-ImageTall",
            "componentName": "장형이미지",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-ImageTall/LT-CP-ImageTall-II02_1.png",
            "headerYn": "Y",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "ImageGroup"
        },
        {
            "componentId": "CP-ItemA",
            "componentName": "아이템A",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-ItemA/LT-CP-ItemA-sHK9_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "ItemGroup"
        },
        {
            "componentId": "CP-ItemB",
            "componentName": "아이템B",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-ItemB/LT-CP-ItemB-ujA1_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "ItemGroup"
        },
        {
            "componentId": "CP-MainTitle",
            "componentName": "메인타이틀",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-MainTitle/LT-CP-MainTitle-67r7_1.png",
            "headerYn": "Y",
            "bodyYn": "N",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "TitleGroup"
        },
        {
            "componentId": "CP-NoticeL",
            "componentName": "노티스",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-NoticeL/LT-CP-NoticeL-J47V_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "layout",
            "options": null,
            "groupComponentId": "NoticeGroup"
        },
        {
            "componentId": "CP-StyleTitleA",
            "componentName": "스타일타이틀A",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-StyleTitleA/LT-CP-StyleTitleA-J68P_1.png",
            "headerYn": "Y",
            "bodyYn": "N",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "TitleGroup"
        },
        {
            "componentId": "CP-Table",
            "componentName": "테이블",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-Table/LT-CP-Table-u43h_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": {
                "rightTextStyle": "normal",
                "rightAlign": "right",
                "leftAlign": "left",
                "leftTextStyle": "normal",
                "maxCount": 10
            },
            "groupComponentId": "TableGroup"
        },
        {
            "componentId": "CP-ThumbDesc",
            "componentName": "서브디스크립션이미지",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-ThumbDesc/LT-CP-ThumbDesc-FkO3_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": {
                "maxCount": "5"
            },
            "groupComponentId": "ThumbDescGroup"
        },
        {
            "componentId": "CP-Thumbnail",
            "componentName": "썸네일 컴포넌트",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-Thumbnail/LT-CP-Thumbnail-m4xC_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": null,
            "groupComponentId": "ThumbnailGroup"
        },
        {
            "componentId": "CP-TitleDesc",
            "componentName": "서브디스크립션타이틀",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-TitleDesc/LT-CP-TitleDesc-BIc2_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": {
                "maxCount": "5"
            },
            "groupComponentId": "TableGroup"
        },
        {
            "componentId": "CP-VButton",
            "componentName": "상하버튼",
            "iconImgFileUrl": "https://file-qa.rcsbizcenter.com/form/component/CP-VButton/LT-CP-VButton-4rtF_1.png",
            "headerYn": "N",
            "bodyYn": "Y",
            "footerYn": "N",
            "status": "public",
            "options": {
                "color": "#1e1e1e"
            },
            "groupComponentId": "ButtonGroup"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 16
    },
    "status": 200
}

error code는 RCS Biz Center - Response body error code 참조

Previous레이아웃Next샘플 레이아웃 목록 조회

Last updated

Was this helpful?