Open API 명세서 | 표준 데이터 관리 시스템

API 목록
검색 결과가 없습니다. 검색어와 조건을 확인해 주세요.

GET

메시지 목록 조회

/api/v1/messages/

공개된 메시지의 목록을 JSON 으로 조회한다. 상세는 `url` 의 RDF 주소로 받는다.

인증 안내

일반 OpenAPI 토큰

사용자 화면에서 발급받은 유효한 OpenAPI 토큰을 사용합니다. $OPEN_API_TOKEN에 토큰 키를 설정하세요. 기존 키 단독 헤더 형식도 지원합니다.

Authorization: Token $OPEN_API_TOKEN

요청 파라미터

3개 항목

파라미터	타입	필수	설명
`page` query	integer	선택	페이지 번호 (최소 1, 기본 1). 범위를 벗어난 값은 1로 보정된다.
`page_size` query	integer	선택	페이지 크기 (기본 20, 최대 100). 100 초과 시 100로 제한된다.
`q` query	string	선택	이름 검색어

응답 정보

HTTP 상태 코드

응답 형식 object

필드	타입	필수	설명
`count`	integer	필수	전체 항목 수
`next`	string null 허용	필수	다음 페이지 URL (없으면 null)
`previous`	string null 허용	필수	이전 페이지 URL (없으면 null)
`results`	array	필수	—
배열 안의 각 항목 ↓
`↳ id`	integer	필수	—
`↳ name`	string	필수	—
`↳ type`	string	필수	유형 코드 (MSG · DF · DE)
`↳ class_curie`	string	필수	클래스 CURIE (예: kadif:Message)
`↳ oid`	string null 허용	필수	OID 점 표기
`↳ url`	string uri	필수	이 API 의 상세(RDF) 주소
`↳ web_url`	string uri	필수	공개 상세 화면 주소 — RDF 안의 노드 URI 와 같다

인증 실패 — 토큰 헤더 누락, 유효하지 않은 토큰, 만료된 토큰, 회수된 토큰

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

리소스 없음 — 존재하지 않는 ID, 비공개/비활성 항목, 현재 미제공(비활성화) API

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

호출 한도 초과 — 분당/일일 한도 초과 (응답 헤더 Retry-After 동봉)

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

서버 내부 오류

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

요청 예제 · curl (Bash / WSL)

토큰 설정 예제의 토큰 변수에 사용할 키를 설정
샘플 값 수정 ID·본문을 원하는 값으로 변경
복사해서 실행 Bash / WSL 터미널에서 실행

현재 서버 주소가 들어 있습니다. 다른 서버를 호출할 때만 주소를 변경하세요. 필수가 아닌 쿼리 항목은 생략할 수 있습니다.

curl -X GET \
  https://datamanagement.itskorea.kr/api/v1/messages/ \
  -H "Authorization: Token $OPEN_API_TOKEN"

API별 인증 방법과 필수 입력값을 확인한 뒤 호출해 주세요. 이용 가이드 →

GET

메시지 상세 조회 (RDF)

/api/v1/messages/{id}/

{id} 부분을 실제 ID로 바꿔주세요.

메시지 한 건을 RDF 로 조회한다. 공개 상세 화면에 보이는 내용 — 기본 설명, 필드(필드명·M/O·최대 반복), 데이터 표현(코드·인코딩), 값 집합, 데이터 유형, 표준 관계, 이 항목을 쓰는 상위 프레임·메시지 — 을 담는다. 형식은 Accept 헤더나 `format` 으로 고르고(기본 JSON-LD), `depth=full` 이면 하위 항목의 내용까지 싣는다. 오류 본문은 JSON 이다.

인증 안내

일반 OpenAPI 토큰

사용자 화면에서 발급받은 유효한 OpenAPI 토큰을 사용합니다. $OPEN_API_TOKEN에 토큰 키를 설정하세요. 기존 키 단독 헤더 형식도 지원합니다.

Authorization: Token $OPEN_API_TOKEN

요청 파라미터

3개 항목

파라미터	타입	필수	설명
`depth` query	string	선택	생략하면 공개 상세 화면의 내용(필드·데이터 표현·값 집합·데이터 유형·활용·연결)을 싣고, 필드가 가리키는 하위 항목은 이름만 싣는다. `full` 이면 필드를 따라 하위 데이터 프레임·데이터 엘리먼트의 내용까지 싣는다. 허용값: full
`format` query	string	선택	응답 형식. Accept 헤더(application/ld+json · text/turtle · application/rdf+xml) 대신 쓸 수 있다. 둘 다 없으면 JSON-LD. 허용값: jsonld, rdf, ttl
`id` path	integer	필수	—

응답 정보

HTTP 상태 코드

RDF 문서 — JSON-LD(application/ld+json) · Turtle(text/turtle) · RDF/XML(application/rdf+xml)

응답 형식 application/ld+json · text/turtle · application/rdf+xml

이 응답에는 필드 정보가 정의되어 있지 않습니다.

요청 예제 · curl (Bash / WSL)

토큰 설정 예제의 토큰 변수에 사용할 키를 설정
샘플 값 수정 ID·본문을 원하는 값으로 변경
복사해서 실행 Bash / WSL 터미널에서 실행

현재 서버 주소가 들어 있습니다. 다른 서버를 호출할 때만 주소를 변경하세요. 필수가 아닌 쿼리 항목은 생략할 수 있습니다.

curl -X GET \
  https://datamanagement.itskorea.kr/api/v1/messages/1/ \
  -H "Authorization: Token $OPEN_API_TOKEN"

API별 인증 방법과 필수 입력값을 확인한 뒤 호출해 주세요. 이용 가이드 →

GET

데이터 프레임 목록 조회

/api/v1/data-frames/

공개된 데이터 프레임의 목록을 JSON 으로 조회한다. 상세는 `url` 의 RDF 주소로 받는다.

인증 안내

일반 OpenAPI 토큰

사용자 화면에서 발급받은 유효한 OpenAPI 토큰을 사용합니다. $OPEN_API_TOKEN에 토큰 키를 설정하세요. 기존 키 단독 헤더 형식도 지원합니다.

Authorization: Token $OPEN_API_TOKEN

요청 파라미터

3개 항목

파라미터	타입	필수	설명
`page` query	integer	선택	페이지 번호 (최소 1, 기본 1). 범위를 벗어난 값은 1로 보정된다.
`page_size` query	integer	선택	페이지 크기 (기본 20, 최대 100). 100 초과 시 100로 제한된다.
`q` query	string	선택	이름 검색어

응답 정보

HTTP 상태 코드

응답 형식 object

필드	타입	필수	설명
`count`	integer	필수	전체 항목 수
`next`	string null 허용	필수	다음 페이지 URL (없으면 null)
`previous`	string null 허용	필수	이전 페이지 URL (없으면 null)
`results`	array	필수	—
배열 안의 각 항목 ↓
`↳ id`	integer	필수	—
`↳ name`	string	필수	—
`↳ type`	string	필수	유형 코드 (MSG · DF · DE)
`↳ class_curie`	string	필수	클래스 CURIE (예: kadif:Message)
`↳ oid`	string null 허용	필수	OID 점 표기
`↳ url`	string uri	필수	이 API 의 상세(RDF) 주소
`↳ web_url`	string uri	필수	공개 상세 화면 주소 — RDF 안의 노드 URI 와 같다

인증 실패 — 토큰 헤더 누락, 유효하지 않은 토큰, 만료된 토큰, 회수된 토큰

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

리소스 없음 — 존재하지 않는 ID, 비공개/비활성 항목, 현재 미제공(비활성화) API

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

호출 한도 초과 — 분당/일일 한도 초과 (응답 헤더 Retry-After 동봉)

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

서버 내부 오류

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

요청 예제 · curl (Bash / WSL)

토큰 설정 예제의 토큰 변수에 사용할 키를 설정
샘플 값 수정 ID·본문을 원하는 값으로 변경
복사해서 실행 Bash / WSL 터미널에서 실행

현재 서버 주소가 들어 있습니다. 다른 서버를 호출할 때만 주소를 변경하세요. 필수가 아닌 쿼리 항목은 생략할 수 있습니다.

curl -X GET \
  https://datamanagement.itskorea.kr/api/v1/data-frames/ \
  -H "Authorization: Token $OPEN_API_TOKEN"

API별 인증 방법과 필수 입력값을 확인한 뒤 호출해 주세요. 이용 가이드 →

GET

데이터 프레임 상세 조회 (RDF)

/api/v1/data-frames/{id}/

{id} 부분을 실제 ID로 바꿔주세요.

데이터 프레임 한 건을 RDF 로 조회한다. 공개 상세 화면에 보이는 내용 — 기본 설명, 필드(필드명·M/O·최대 반복), 데이터 표현(코드·인코딩), 값 집합, 데이터 유형, 표준 관계, 이 항목을 쓰는 상위 프레임·메시지 — 을 담는다. 형식은 Accept 헤더나 `format` 으로 고르고(기본 JSON-LD), `depth=full` 이면 하위 항목의 내용까지 싣는다. 오류 본문은 JSON 이다.

인증 안내

일반 OpenAPI 토큰

사용자 화면에서 발급받은 유효한 OpenAPI 토큰을 사용합니다. $OPEN_API_TOKEN에 토큰 키를 설정하세요. 기존 키 단독 헤더 형식도 지원합니다.

Authorization: Token $OPEN_API_TOKEN

요청 파라미터

3개 항목

파라미터	타입	필수	설명
`depth` query	string	선택	생략하면 공개 상세 화면의 내용(필드·데이터 표현·값 집합·데이터 유형·활용·연결)을 싣고, 필드가 가리키는 하위 항목은 이름만 싣는다. `full` 이면 필드를 따라 하위 데이터 프레임·데이터 엘리먼트의 내용까지 싣는다. 허용값: full
`format` query	string	선택	응답 형식. Accept 헤더(application/ld+json · text/turtle · application/rdf+xml) 대신 쓸 수 있다. 둘 다 없으면 JSON-LD. 허용값: jsonld, rdf, ttl
`id` path	integer	필수	—

응답 정보

HTTP 상태 코드

RDF 문서 — JSON-LD(application/ld+json) · Turtle(text/turtle) · RDF/XML(application/rdf+xml)

응답 형식 application/ld+json · text/turtle · application/rdf+xml

이 응답에는 필드 정보가 정의되어 있지 않습니다.

요청 예제 · curl (Bash / WSL)

토큰 설정 예제의 토큰 변수에 사용할 키를 설정
샘플 값 수정 ID·본문을 원하는 값으로 변경
복사해서 실행 Bash / WSL 터미널에서 실행

현재 서버 주소가 들어 있습니다. 다른 서버를 호출할 때만 주소를 변경하세요. 필수가 아닌 쿼리 항목은 생략할 수 있습니다.

curl -X GET \
  https://datamanagement.itskorea.kr/api/v1/data-frames/1/ \
  -H "Authorization: Token $OPEN_API_TOKEN"

API별 인증 방법과 필수 입력값을 확인한 뒤 호출해 주세요. 이용 가이드 →

GET

데이터 엘리먼트 목록 조회

/api/v1/data-elements/

공개된 데이터 엘리먼트의 목록을 JSON 으로 조회한다. 상세는 `url` 의 RDF 주소로 받는다.

인증 안내

일반 OpenAPI 토큰

사용자 화면에서 발급받은 유효한 OpenAPI 토큰을 사용합니다. $OPEN_API_TOKEN에 토큰 키를 설정하세요. 기존 키 단독 헤더 형식도 지원합니다.

Authorization: Token $OPEN_API_TOKEN

요청 파라미터

3개 항목

파라미터	타입	필수	설명
`page` query	integer	선택	페이지 번호 (최소 1, 기본 1). 범위를 벗어난 값은 1로 보정된다.
`page_size` query	integer	선택	페이지 크기 (기본 20, 최대 100). 100 초과 시 100로 제한된다.
`q` query	string	선택	이름 검색어

응답 정보

HTTP 상태 코드

응답 형식 object

필드	타입	필수	설명
`count`	integer	필수	전체 항목 수
`next`	string null 허용	필수	다음 페이지 URL (없으면 null)
`previous`	string null 허용	필수	이전 페이지 URL (없으면 null)
`results`	array	필수	—
배열 안의 각 항목 ↓
`↳ id`	integer	필수	—
`↳ name`	string	필수	—
`↳ type`	string	필수	유형 코드 (MSG · DF · DE)
`↳ class_curie`	string	필수	클래스 CURIE (예: kadif:Message)
`↳ oid`	string null 허용	필수	OID 점 표기
`↳ url`	string uri	필수	이 API 의 상세(RDF) 주소
`↳ web_url`	string uri	필수	공개 상세 화면 주소 — RDF 안의 노드 URI 와 같다

인증 실패 — 토큰 헤더 누락, 유효하지 않은 토큰, 만료된 토큰, 회수된 토큰

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

리소스 없음 — 존재하지 않는 ID, 비공개/비활성 항목, 현재 미제공(비활성화) API

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

호출 한도 초과 — 분당/일일 한도 초과 (응답 헤더 Retry-After 동봉)

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

서버 내부 오류

응답 형식 object

필드	타입	필수	설명
`↳ [key]`	JSON (제한 없음)	선택	—

요청 예제 · curl (Bash / WSL)

토큰 설정 예제의 토큰 변수에 사용할 키를 설정
샘플 값 수정 ID·본문을 원하는 값으로 변경
복사해서 실행 Bash / WSL 터미널에서 실행

현재 서버 주소가 들어 있습니다. 다른 서버를 호출할 때만 주소를 변경하세요. 필수가 아닌 쿼리 항목은 생략할 수 있습니다.

curl -X GET \
  https://datamanagement.itskorea.kr/api/v1/data-elements/ \
  -H "Authorization: Token $OPEN_API_TOKEN"

API별 인증 방법과 필수 입력값을 확인한 뒤 호출해 주세요. 이용 가이드 →

GET

데이터 엘리먼트 상세 조회 (RDF)

/api/v1/data-elements/{id}/

{id} 부분을 실제 ID로 바꿔주세요.

데이터 엘리먼트 한 건을 RDF 로 조회한다. 공개 상세 화면에 보이는 내용 — 기본 설명, 필드(필드명·M/O·최대 반복), 데이터 표현(코드·인코딩), 값 집합, 데이터 유형, 표준 관계, 이 항목을 쓰는 상위 프레임·메시지 — 을 담는다. 형식은 Accept 헤더나 `format` 으로 고르고(기본 JSON-LD), `depth=full` 이면 하위 항목의 내용까지 싣는다. 오류 본문은 JSON 이다.

인증 안내

일반 OpenAPI 토큰

사용자 화면에서 발급받은 유효한 OpenAPI 토큰을 사용합니다. $OPEN_API_TOKEN에 토큰 키를 설정하세요. 기존 키 단독 헤더 형식도 지원합니다.

Authorization: Token $OPEN_API_TOKEN

요청 파라미터

3개 항목

파라미터	타입	필수	설명
`depth` query	string	선택	생략하면 공개 상세 화면의 내용(필드·데이터 표현·값 집합·데이터 유형·활용·연결)을 싣고, 필드가 가리키는 하위 항목은 이름만 싣는다. `full` 이면 필드를 따라 하위 데이터 프레임·데이터 엘리먼트의 내용까지 싣는다. 허용값: full
`format` query	string	선택	응답 형식. Accept 헤더(application/ld+json · text/turtle · application/rdf+xml) 대신 쓸 수 있다. 둘 다 없으면 JSON-LD. 허용값: jsonld, rdf, ttl
`id` path	integer	필수	—

응답 정보

HTTP 상태 코드

RDF 문서 — JSON-LD(application/ld+json) · Turtle(text/turtle) · RDF/XML(application/rdf+xml)

응답 형식 application/ld+json · text/turtle · application/rdf+xml

이 응답에는 필드 정보가 정의되어 있지 않습니다.

요청 예제 · curl (Bash / WSL)

토큰 설정 예제의 토큰 변수에 사용할 키를 설정
샘플 값 수정 ID·본문을 원하는 값으로 변경
복사해서 실행 Bash / WSL 터미널에서 실행

현재 서버 주소가 들어 있습니다. 다른 서버를 호출할 때만 주소를 변경하세요. 필수가 아닌 쿼리 항목은 생략할 수 있습니다.

curl -X GET \
  https://datamanagement.itskorea.kr/api/v1/data-elements/1/ \
  -H "Authorization: Token $OPEN_API_TOKEN"

API별 인증 방법과 필수 입력값을 확인한 뒤 호출해 주세요. 이용 가이드 →