OAI 프로토콜 이용 방법

OAI 프로토콜 사용

OAI 프로토콜은 다음의 6가지 요청(verb)으로 구성되며, HTTP GET 또는 POST 방식을 사용하여 메타데이터를 요청합니다. 모든 OAI 프로토콜 요청에 대한 응답은 XML 문서입니다.

OAI-PMH 사용 신청 등록된 서버 IP로만 API 접속이 허용됩니다. key는 발급받은 인증키를 사용하셔야 합니다.

자세한 사항은 Open Archives Initiative의 Guidelines을 참조하십시오(http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm#ProtocolMessages )

1. ListSets

저장소의 세트 구성을 얻을 수 있습니다.

요청 파라미터

파라미터(영문)	타입	필수항목	설명	예
verb	CHAR	Y	OAI-PMH requests.	Listsets
key	CHAR	Y	승인된 발급	86118B76CCEF9ADC18E7D0778CCC28E2

요청 예

https://dataon.kisti.re.kr/registry/oaipmh?verb=ListSets&key=86118B76CCEF9ADC18E7D0778CCC28E2

응답 파라미터

파라미터(영문)	설명	예
set_spec	스펙설	DataON
set_name	이름설	DataON

응답 예

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2020-12-16T12:05:40Z</responseDate>
<request verb="ListSets" adminTest="true">https://dataon.kisti.re.kr/registry/oaipmh</request>
<ListSets>
<set>
<setSpec>DataON</setSpec>
<setName>DataON</setName>
</set>
<set>
<setSpec>DataON</setSpec>
<setName>DataON</setName>
</set>
</ListSets>
</OAI-PMH>

2. Identify

저장소의 정보를 얻을 수 있습니다.

요청 파라미터

파라미터(영문)	타입	필수항목	설명	예
verb	CHAR	Y	OAI-PMH requests.	Listsets
key	CHAR	Y	승인된 발급	86118B76CCEF9ADC18E7D0778CCC28E2

요청 예

https://dataon.kisti.re.kr/registry/oaipmh?verb=Identify&key=86118B76CCEF9ADC18E7D0778CCC28E2

응답 파라미터

파라미터(영문)	설명	예
repositoryName	레파지터리 명	Korea Reseach Data Platform
baseURL	url	https://dataon.kisti.re.kr/registry/oaipmh
protocolVersion	버전	[e-mail]
adminEmail	관리자 이메일	[e-mail]
earliestDatestamp	최초 생성일	2019-12-16T00:00:00Z
deletedRecord	삭제 기록 no-저장소는 삭제에 대한 정보를 유지하지 않습니다. 이 수준의 지원을 나타내는 저장소 는 어떤 응답에서도 삭제 된 상태를 나타내서 는 안됩니다 . persistent-저장소는 시간 제한없이 삭제에 대한 정보를 유지합니다. 지원의 수준을 나타내는 저장소가 있어야 지속적으로 삭제의 전체 역사를 추적하고 지속적으로 시간이 지남에 따라 삭제 된 레코드의 상태를 알 수있다. transient-저장소는 삭제 목록이 지속적으로 또는 일관 적으로 유지되는 것을 보장하지 않습니다. 이 수준의 지원을 나타내는 저장소는 레코드의 삭제 상태를 표시 할 수 있습니다 .	transient
granularity	리포지토리는 날짜 또는 초 단위로 날짜 스탬프를 표현	2020-06-26T09:58:14Z

응답 예

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2020-12-16T11:56:05Z</responseDate>
<request verb="Identify" adminTest="true">https://dataon.kisti.re.kr/registry/oaipmh</request>
<Identify>
<repositoryName>Korea Reseach Data Platform</repositoryName>
<baseURL>https://dataon.kisti.re.kr/registry/oaipmh</baseURL>
<protocolVersion>2.0</protocolVersion>
<adminEmail>[e-mail]</adminEmail>
<earliestDatestamp>2019-12-16T00:00:00Z</earliestDatestamp>
<deletedRecord>transient</deletedRecord>
<granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
</Identify>
</OAI-PMH>

3. ListMetadataFormats

저장소에서 사용 가능한 메타 데이터 레코드 형식 목록을 검색한다.

요청 파라미터

파라미터(영문)	타입	필수항목	설명	예
verb	CHAR	Y	OAI-PMH requests.	Listsets
key	CHAR	Y	승인된 발급	86118B76CCEF9ADC18E7D0778CCC28E2
identifier	CHAR	N	서비스식별	3c38f631d097edbb2ed589c0be73d5da

요청 예

https://dataon.kisti.re.kr/registry/oaipmh?verb=ListMetadataFormats&key=86118B76CCEF9ADC18E7D0778CCC28E2

응답 파라미터

파라미터(영문)	설명	예
metadataPrefix	메타데이터_접두사	oai_dc
schema	스키마	http://www.openarchives.org/OAI/2.0/oai_dc.xsd metadataNamespace
set_name	메타데이터_네임스페이스	http://www.openarchives.org/OAI/2.0/oai_dc/

응답 예

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2020-12-16T13:35:55Z</responseDate>
<request verb="ListMetadataFormats" adminTest="true" identifier="3c38f631d097edbb2ed589c0be73d5da">https://dataon.kisti.re.kr/registry/oaipmh</request>
<ListMetadataFormats>
<metadataFormat>
<metadataFormat>
<metadataPrefix>oai_dc</metadataPrefix>
<schema>http://www.openarchives.org/OAI/2.0/oai_dc.xsd</schema>
<metadataNamespace>http://www.openarchives.org/OAI/2.0/oai_dc/</metadataNamespace>
</metadataFormat>
<metadataFormat>
<metadataPrefix>oai_datacite</metadataPrefix>
<schema>http://schema.DataCite.org/oai/oai-1.1/oai.xsd</schema>
<metadataNamespace>http://schema.DataCite.org/oai/oai-1.1/</metadataNamespace>
</metadataFormat>
</metadataFormat>
</ListMetadataFormats>
</OAI-PMH>

4. ListIdentifiers

저장소에서 메타 데이터 레코드의 헤더 만의 목록을 얻을 수 있습니다.

요청 파라미터

파라미터(영문)	타입	필수항목	설명	예
verb	CHAR	Y	OAI-PMH requests.	Listsets
key	CHAR	Y	승인된 발급	86118B76CCEF9ADC18E7D0778CCC28E2
metadataPrefix	CHAR	Y	메타데이터 접두사	oai_dc, oai_datacite, openaire_data
from	CHAR	N	시작일자	19900101
until	CHAR	N	마지막일자	20201124

요청 예

https://dataon.kisti.re.kr/registry/oaipmh?verb=ListIdentifiers&metadataPrefix=oai_dc&key=86118B76CCEF9ADC18E7D0778CCC28E2

응답 파라미터

파라미터(영문)	설명	예
identifier	식별자	0dfa8912851f6f54c1a50e026740da48
datestamp	날짜	26T09:58:14Z
setSpec	데이터를 그룹화하는 구조	dataset

응답 예

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2020-12-16T13:45:29Z</responseDate>
<request verb="ListIdentifiers" metadataPrefix="oai_dc" adminTest="true">https://dataon.kisti.re.kr/registry/oaipmh</request>
<ListIdentifiers>
<header>
<identifier>aa4f7523177299fe7c3539e7fb7a452c</identifier>
<datestamp>2020-12-14T16:15:07Z</datestamp>
<setSpec>dataset</setSpec>
</header>
<header>
<identifier>1b84be77acdf8af5967ed6a4c6493fcc</identifier>
<datestamp>2020-12-11T15:42:55Z</datestamp>
<setSpec>dataset</setSpec>
</header>
<header>
<identifier>3517f6e2c61bc44ec2bfd61c2e23ca91</identifier>
<datestamp>2020-12-11T14:08:19Z</datestamp>
<setSpec>dataset</setSpec>
</header>
<header>
<identifier>aa07f3e7a0f1d327714a90cd7c1be213</identifier>
<datestamp>2020-12-11T07:10:46Z</datestamp>
<setSpec>dataset</setSpec>
</header>
</<OAI-PMH>

5. ListRecords

저장소에서 모든 메타 데이터 레코드 목록을 가져옵니다.

요청 파라미터

파라미터(영문)	타입	필수항목	설명	예
verb	CHAR	Y	OAI-PMH requests.	Listsets
key	CHAR	Y	승인된 발급	86118B76CCEF9ADC18E7D0778CCC28E2
metadataPrefix	CHAR	Y	메타데이터 접두사	oai_dc, oai_datacite, openaire_data
from	CHAR	N	시작일자	19900101
until	CHAR	N	마지막일자	20201124
resumptionToken	CHAR	N	한번에 모든 레코드를 읽어올 수 없기 때문에 다음 레코드를 읽기위한 resumptionToken 발행	80c210afde5d313e987349b8d9ae02eefad00e5f5dcd4735c5a89961a25f0687

요청 예

https://dataon.kisti.re.kr/registry/oaipmh?verb=ListRecords&metadataPrefix=oai_dc&key=86118B76CCEF9ADC18E7D0778CCC28E2

응답 파라미터

파라미터(영문)	설명	예
identifier	식별자	d8b35d7b1029bf1e90199b814cd3de88
datestamp	날짜	2019-12-15T15:12:32Z
setSpec	스펙 설정	dataset
title	제목	유도결합 플라즈마 질량(ICP-MS) 분석
creator	생산자	강일모
subject	주제	Archaeology
description	설명	연구데이터설명입니다.
publisher	발행	한국지질자원연구원
date	날짜	2020-06-26T09:58:14Z
type	타입	dataset
format	파일 포맷	etc;hwp
identifier	식별자	3c38f631d097edbb2ed589c0be73d5da
language	언어	Korean
url	url	https://dataon.kisti.re.kr
rights	권한	공개, 비공개, 엠바고
relation	관계
source	소스	한국지질자원연구원
coverage	데이터위치정보
ntisPjtNo	ntis과제고유번호	1711051630
resumptionToken	한번에 모든 레코드를 읽어올 수 없기 때문에 다음 레코드를 읽기위한 resumptionToken 발행	80c210afde5d313e987349b8d9ae02eefad00e5f5dcd4735c5a89961a25f0687

응답 예

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2020-12-16T14:22:28Z</responseDate>
<request verb="ListRecords" metadataPrefix="oai_dc" adminTest="true">https://dataon.kisti.re.kr/registry/oaipmh</request>
<ListRecords>
<record>
<header>
<identifier>aa4f7523177299fe7c3539e7fb7a452c</identifier>
<datestamp>2020-12-14T16:15:07Z</datestamp>
<setSpec>dataset</setSpec>
</header>
<metadata>
<dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:title lang="Korean">테스트 데이터</dc:title>
<dc:creator lang="Korean">생산자</dc:creator>
<dc:subject lang=""/>
<dc:description lang="Korean">테스트 데이터 설명입니다.</dc:description>
<dc:publisher lang="Korean">국가연구데이터플랫폼</dc:publisher>
<dc:date/>
<dc:type>dataset</dc:type>
<dc:format>txt</dc:format>
<dc:identifier>aa4f7523177299fe7c3539e7fb7a452c</dc:identifier>
<dc:language>Korean</dc:language>
<dc:url/>
<dc:rights>CC-BY-SA</dc:rights>
<dc:relation/>
<dc:source>국가연구데이터플랫폼</dc:source>
<dc:coverage/>
<dc:ntisPjtNo/>
</dc>
</metadata>
<resumptionToken completeListSize="2985390" cursor="100">80c210afde5d313e987349b8d9ae02eefad00e5f5dcd4735c5a89961a25f0687</resumptionToken>
</ListRecords>
</OAI-PMH>

6. GetRecord

저장소에서 개별 메타 데이터 레코드를 검색한다.

요청 파라미터

파라미터(영문)	타입	필수항목	설명	예
verb	CHAR	Y	OAI-PMH requests.	Listsets
key	CHAR	Y	승인된 발급	86118B76CCEF9ADC18E7D0778CCC28E2
metadataPrefix	CHAR	Y	메타데이터 접두사	oai_dc, oai_datacite, openaire_data
identifier	CHAR	Y	svc_id(식별자)	3c38f631d097edbb2ed589c0be73d5da
resumptionToken	CHAR	N	80c210afde5d313e987349b8d9ae02eefad00e5f5dcd4735c5a89961a25f0687	80c210afde5d313e987349b8d9ae02eefad00e5f5dcd4735c5a89961a25f0687

요청 예

https://dataon.kisti.re.kr/registry/oaipmh?verb=GetRecord&metadataPrefix=oai_dc&identifier=d8b35d7b1029bf1e90199b814cd3de88&key=86118B76CCEF9ADC18E7D0778CCC28E2

응답 파라미터

파라미터(영문)	설명	예
identifier	식별자	d8b35d7b1029bf1e90199b814cd3de88
datestamp	날짜	2019-12-15T15:12:32Z
setSpec	스펙 설정	dataset
title	제목	유도결합 플라즈마 질량(ICP-MS) 분석
creator	생산자	강일모
subject	주제	Archaeology
description	설명	연구데이터설명입니다.
publisher	발행	한국지질자원연구원
date	날짜	2020-06-26T09:58:14Z
type	타입	dataset
format	파일 포맷	etc;hwp
identifier	식별자	3c38f631d097edbb2ed589c0be73d5da
language	언어	Korean
url	url	https://dataon.kisti.re.kr
rights	권한	공개, 비공개, 엠바고
relation	관계
source	소스	한국지질자원연구원
coverage	데이터위치정보
ntisPjtNo	ntis과제고유번호	1711051630

응답 예

<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2020-12-16T14:15:47Z</responseDate>
<request verb="GetRecord" metadataPrefix="oai_dc" adminTest="true" identifier="7ac249c046a12c8df4796e65386e9d8d">https://dataon.kisti.re.kr/registry/oaipmh</request>
<GetRecord>
<record>
<header>
<identifier>7ac249c046a12c8df4796e65386e9d8d</identifier>
<datestamp>2019-12-15T15:12:36Z</datestamp>
<setSpec>dataset</setSpec>
</header>
<metadata>
<dc xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd">
<dc:title lang="Korean">광물자원탐사, 개발 및 처리 교육</dc:title>
<dc:subject lang=""/>
<dc:publisher lang="Korean">한국지질자원연구원</dc:publisher>
<dc:date/>
<dc:type>dataset</dc:type>
<dc:format/>
<dc:identifier>7ac249c046a12c8df4796e65386e9d8d</dc:identifier>
<dc:language>Korean</dc:language>
<dc:url>/redirect_landing.do?datasetId=oai:gdr.kigam.re.kr:open_repository/4985</dc:url>
<dc:rights/>
<dc:relation/>
<dc:source>한국지질자원연구원</dc:source>
<dc:coverage/>
<dc:ntisPjtNo>1711041349</dc:ntisPjtNo>
</dc>
</metadata>
</record>
<resumptionToken completeListSize="2985390" cursor="100">80c210afde5d313e987349b8d9ae02eefad00e5f5dcd4735c5a89961a25f0687</resumptionToken>
</ListRecords>
</OAI-PMH>