メディア芸術データベース(ベータ版) webapi仕様...1. リソース検索 2....

1. リソース検索

2. 分野ID取得

3. Open API

4. 参照資料

「1. リソース検索」に事例を1件追加

メディア芸術データベース(ベータ版) 　WebAPI仕様

2019/11/29

更新履歴

1

2

日付更新内容No.

2020/01/09

本仕様書をリリース

1 / 20

1. リソース検索

指定する条件に合致するリソースの取得を行う。

リクエスト／レスポンスの概要は下図の通り。

検索結果（json）

(1) 概要

パス https://mediaarts-db.bunka.go.jp/api/search

リクエストメソッド GET

リクエストパラメータ下表参照

レスポンス 200 検索結果出力

400 不正パラメータ

404 該当データなし

405 GET以外のリクエストメソッドのとき

アクセス制御提供アクセス権限設定に従って制御する

(2) パラメータ仕様

No. パラメータ値パラメータ名必須データ型デフォルト値内容

1 fieldId 分野ID × 文字列 - 検索する分野IDを指定する　※詳細は[4.参照資料]に記載

2 categoryId 情報資源分類ID × 文字列 - 検索する情報資源分類IDを指定する　※詳細は[4.参照資料]に記載

3 subcategoryId 情報資源小分類ID × 文字列 - 検索する情報資源小分類IDを指定する　※詳細は[4.参照資料]に記載

4 aipId 保存データID × 文字列 - 保存データを特定するためのID

5 keyword キーワード × 文字列 - 検索対象とするキーワードを指定する

6 sort ソートタイプ × 文字列 title titleまたはdateとする

7 offset 取得開始件数 × 数値 0 数値はintとする

8 limit 最大取得件数 × 数値 20 数値はintとし最大値は1000とする

(3) レスポンス仕様

jsonフォーマットによる、条件に合致するリソースの返戻とする。

No. フィールド値フィールド名データ型内容

1 hitnum 検索件数数値検索結果件数

2 recode レコード配列検索条件と一致したレコード

3 fieldId 分野ID 文字列検索条件と一致したレコードの分野ID　※詳細は[4.参照資料]に記載

4 categoryId 情報資源分類ID 文字列検索条件と一致したレコードの情報資源分類ID　※詳細は[4.参照資料]に記載

5 subcategoryId 情報資源小分類ID 文字列検索条件と一致したレコードの情報資源小分類ID　※詳細は[4.参照資料]に記載

6 aipId 保存データID 文字列検索条件と一致したレコードの保存データID

7 metadata メタデータ配列検索条件と一致したレコードのメタデータ

8 指定メタデータキー - 文字列メタデータキー名

9 全メタデータ値 - 配列(文字列) メタデータの値

(4) 事例

例１) マンガ-アイテム-単行本（分野ID：manga、情報資源分類ID：cm-item、情報資源小分類ID：cm101）で「ドラゴンボール」をキーワード検索し、公開年月日の降順に最大5件取得

リクエストURL

レスポンス {

hitnum: 248,

record: [

{

fieldId: "manga",

categoryId: "cm-item",

subcategoryId: "cm101",

aipId: "M527795",

metadata: {

rdf:type: [

Item

],

schema:additionalType: [

cm

],

schema:genre: [

単行本

],

schema:name: [

DRAGON BALL超(スーパー)ブロリー : アニメコミックス

問合せ者

メディア芸術

データベース

公開

API

検索リクエスト

（URL）

https://mediaarts-db.bunka.go.jp/api/search?fieldId=manga&categoryId=cm-item&subcategoryId=cm101&keyword=ドラゴンボール

&sort=date&limit=5

2 / 20

],

schema:name xml:lang=\ja-Hrkt\"": [

ドラゴンボールスーパーブロリー : アニメコミックス,

DRAGON BALL超ブロリー

],

schema:creator: [

[原作・脚本・キャラクターデザイン]鳥山明,

[編]ジャンプ・コミック出版編集部

],

schema:publisher: [

集英社　∥　シュウエイシャ

],

schema:datePublished: [

2019-05

],

schema:inLanguage: [

日本語

],

schema:isPartOf: [

C417898

],

ma:sortKey: [

1.0

],

ma:creatorLabel: [

鳥山, 明　∥　トリヤマ, アキラ,

集英社

],

dcterms:creator: [

C53398,

C57371

],

schema:brand: [

ジャンプコミックス

],

schema:brand xml:lang=\ja-Hrkt\"": [


],

ma:locationpubllished: [

東京

],

ma:extent: [

359p

],

ma:dimension: [

18cm

],

schema:isbn: [

9784088820026

],

ma:nbn: [

23216566

],

ma:ndc: [

726.1

],

ma:note: [

表紙のタイトル: DRAGON BALL SUPER BROLY　／　NDC（9版）はNDC（10版）を自動変換した値である。

],

madbdata:oldDateModified: [

2019-07-23T15:34:11

]

}

},

{

fieldId: "manga",


3 / 20


aipId: "M527821",

metadata: {

rdf:type: [

Item

],


cm

],

schema:genre: [

単行本

],

schema:name: [

スーパードラゴンボールヒーローズユニバースミッション!! = SUPER DRAGONBALL HEROES UNIVERSE MISSION!!

],


スーパードラゴンボールヒーローズユニバースミッション,

SUPER DRAGONBALL HEROES UNIVERSE MISSION!!監獄惑星

],

schema:issueNumber: [

1

],

schema:creator: [

[著]ながやま由貴

],

schema:publisher: [


],


2019-05

],

schema:description: [

監獄惑星

],


日本語

],

schema:isPartOf: [

C418248

],

ma:sortKey: [

1.0

],

ma:creatorLabel: [

ながやま, 由貴　∥　ナガヤマ, ヨシタカ

],

dcterms:creator: [

C54457

],

schema:brand: [


],



],


東京

],

ma:extent: [

196p

],

ma:dimension: [

18cm

],

schema:isbn: [

9784088818504

],

4 / 20

ma:nbn: [

23216576

],

ma:ndc: [

726.1

],

ma:note: [

NDC（9版）はNDC（10版）を自動変換した値である。

],


2019-07-23T15:34:11

]

}

},

{

fieldId: "manga",



aipId: "M527079",

metadata: {

rdf:type: [

Item

],


cm

],

schema:genre: [

単行本

],

schema:name: [

ドラゴンボール超(スーパー)

],


ドラゴンボールスーパー,

ドラゴンボール超決着と結末

],


9

],

schema:creator: [

[原作]鳥山明,

[漫画]とよたろう

],

schema:publisher: [


],


2019-04

],


決着と結末

],


日本語

],

schema:isPartOf: [

C361777

],

ma:sortKey: [

9.0

],

ma:creatorLabel: [

鳥山, 明　∥　トリヤマ, アキラ,

とよたろう　∥　トヨタロウ

],

dcterms:creator: [

C53398,

5 / 20

C53261

],

schema:brand: [


],



],


東京

],

ma:extent: [

191p

],

ma:dimension: [

18cm

],

schema:isbn: [

9784088818115

],

ma:nbn: [

23208119

],

ma:ndc: [

726.1

],

ma:note: [

タイトルは奥付・背による.標題紙・表紙のタイトル: DRAGON BALL超　／　NDC（9版）はNDC（10版）を自動変換した値である。

],


2019-07-23T15:33:43

]

}

},

{

fieldId: "manga",



aipId: "M522811",

metadata: {

rdf:type: [

Item

],


cm

],

schema:genre: [

単行本

],

schema:name: [


],



ドラゴンボール超孫悟空覚醒の\兆\""

],


8

],

schema:creator: [

[原作]鳥山明,


],

schema:publisher: [


],


6 / 20

2018-12

],


孫悟空覚醒の\兆\""

],


日本語

],

schema:isPartOf: [

C361777

],

ma:sortKey: [

8.0

],

ma:creatorLabel: [


],

dcterms:creator: [

C53261

],

schema:brand: [


],



],


東京

],

ma:extent: [

185p

],

ma:dimension: [

18cm

],

schema:isbn: [

9784088816494

],

ma:nbn: [

23147565

],

ma:ndc: [

726.1

],

ma:note: [


],


2019-07-23T13:30:12

]

}

},

{

fieldId: "manga",



aipId: "M529302",

metadata: {

rdf:type: [

Item

],


cm

],

schema:genre: [

単行本

],

7 / 20

schema:name: [


],



ドラゴンボール超宇宙サバイバル!力の大会開始!

],


7

],

schema:creator: [

[原作]鳥山明,


],

schema:publisher: [


],


2018-09

],


宇宙サバイバル!力の大会開始!

],


日本語

],

schema:isPartOf: [

C361777

],

ma:sortKey: [

7.0

],

ma:creatorLabel: [


],

dcterms:creator: [

C53261

],

schema:brand: [


],



],


東京

],

ma:extent: [

189p

],

ma:dimension: [

18cm

],

schema:isbn: [

9784088815756

],

ma:nbn: [

23108155

],

ma:ndc: [

726.1

],

ma:note: [


],


2019-07-29T16:31:45

8 / 20

]

}

}

]

}

例２) アニメーション-アイテム-テレビ番組（分野ID：animation、情報資源分類ID：an-item、情報資源小分類ID：an201）から最大3件のデータを取得

リクエストURL https://mediaarts-db.bunka.go.jp/api/search?fieldId=animation&categoryId=an-item&subcategoryId=an201&limit=3

レスポンス {

hitnum: 113186,

record: [

{

fieldId: "animation",

categoryId: "an-item",

subcategoryId: "an201",

aipId: "M127506",

metadata: {

rdf:type: [

Item

],


an

],

schema:name: [

- スタミュ -高校星歌劇

],


スタミュコウコウセイカゲキ

],

schema:alternativeHeadline: [

9 / 20

-- 第1幕 --

],


1

],

schema:publisher: [

MX

],


2015-10-06

],

schema:isPartOf: [

C15673

],

ma:media: [

TVレギュラー

],

ma:relatedFirst: [

1

],

ma:originalTitle: [

-- スタミュ --高校星歌劇

],

ma:notationNumber: [

1

],

ma:runtime: [

30分

],

ma:note: [

[各話タイトル（改行を含む）]-- 第1幕 --

],

ma:source: [

カレント2016新規登録（CRNT2016）

],

ma:accessRights: [

G

],


2017-05-11T16:40:23

]

}

},

{




aipId: "M127507",

metadata: {

rdf:type: [

Item

],


an

],

schema:name: [


],



],


-- 第2幕 --

],


2

],

10 / 20

schema:publisher: [

MX

],


2015-10-13

],

schema:isPartOf: [

C15673

],

ma:media: [

TVレギュラー

],

ma:relatedFirst: [

1

],

ma:originalTitle: [


],


2

],

ma:runtime: [

30分

],

ma:note: [


],

ma:source: [


],

ma:accessRights: [

G

],


2017-05-11T16:40:23

]

}

},

{




aipId: "M127508",

metadata: {

rdf:type: [

Item

],


an

],

schema:name: [


],



],


-- 第3幕 --

],


3

],

schema:publisher: [

MX

],


2015-10-20

11 / 20

],

schema:isPartOf: [

C15673

],

ma:media: [

TVレギュラー

],

ma:relatedFirst: [

1

],

ma:originalTitle: [


],


3

],

ma:runtime: [

30分

],

ma:note: [


],

ma:source: [


],

ma:accessRights: [

G

],


2017-05-11T16:40:23

]

}

}

]

}

12 / 20

2. 分野ID取得

指定された分野の取得を行う


検索結果（json）

(1) 概要

パス https://mediaarts-db.bunka.go.jp/api/field


リクエストパラメータ下表参照

レスポンス 200 結果出力

400 不正パラメータ


アクセス権限提供アクセス権限設定に従って制御する

(2) パラメータ仕様

No. パラメータ値パラメータ名必須データ型デフォルト値内容

1 fieldId 分野ID × 文字列 - 検索する分野IDを指定する（完全一致）　※詳細は[4.参照資料]に記載


jsonフォーマットによる返戻とする。


1 fields 分野配列 -

2 fieldId 分野ID 文字列検索条件と一致した分野ID　※詳細は[4.参照資料]に記載

3 categories 情報資源分類配列 -

4 categoryId 情報資源分類ID 文字列分野に属する情報資源分類ID　※詳細は[4.参照資料]に記載

5 subcategories 情報資源小分類配列 -

6 subcategoryId 情報資源小分類ID 文字列情報資源分類に属する情報資源小分類ID　※詳細は[4.参照資料]に記載

(4) 事例

例) マンガ（分野ID：manga）の情報資源小分類IDを取得

リクエストURL https://mediaarts-db.bunka.go.jp/api/field?fieldId=manga

レスポンス {

fields: [

{

fieldId: "manga",

categories: [

{


subcategories: [

{

subcategoryId: "cm101"

},

{


},

{


},

{


},

{


},

{


},

{


}

]

},

{

問合せ者

メディア芸術

データベース

公開

API

検索リクエスト

（URL）

13 / 20

categoryId: "cm-col",

subcategories: [

{


},

{


},

{


},

{


}

]

}

]

}

]

}

14 / 20

3. Open API


結果（json）

(1) 概要

パス https://mediaarts-db.bunka.go.jp/api/openapi.json


レスポンス 200 検索結果出力


アクセス制御提供アクセス権限設定に従って制御する


jsonフォーマットによる返戻とする。


1 openapi オープンAPI 数値 Open APIの字バージョン情報

2 info 情報文字列 API情報

3 servers サーバ文字列 APIサーバー情報

4 paths パス文字列 AIPパス情報

5 components 構成文字列レスポンスの構成情報

(3) 事例

リクエストURL https://mediaarts-db.bunka.go.jp/api/openapi.json

レスポンス {

openapi: "3.0.2",

info: {

title: "メディア芸術データベース API",

version: "1.0.0",

description: "メディア芸術データベース API",

contact: {

url: "https://mediaarts-db.bunka.go.jp/"

},

license: {

name: "Proprietary",

url: "https://mediaarts-db.bunka.go.jp/"

}

},

servers: [

{

url: "https://mediaarts-db.bunka.go.jp/",

description: "メディア芸術データベース API"

}

],

paths: {

/api/search: {

get: {

operationId: "searchResource",

description: "指定する条件に合致するリソースの取得を行う",

parameters: [

{

name: "fieldId",

in: "query",

description: "分野ID",

required: false,

schema: {

type: "string",

description: "検索する分野IDを指定する"

}

},

{

name: "categoryId",

in: "query",

description: "情報資源分類ID",

required: false,

問合せ者

メディア芸術

データベース

Open A

PI

リクエスト

（URL）

15 / 20

schema: {

type: "string",

description: "検索する情報資源分類IDを指定する"

}

},

{

name: "subcategoryId",

in: "query",

description: "情報資源省分類ID",

required: false,

schema: {

type: "string",

description: "検索する情報資源省分類IDを指定する"

}

},

{

name: "aipId",

in: "query",

description: "保存データID",

required: false,

schema: {

type: "string",

description: "保存データを特定するためのID"

}

},

{

name: "keyword",

in: "query",

description: "キーワード",

required: false,

schema: {

type: "string",

description: "検索対象とするキーワードを指定する"

}

},

{

name: "sort",

in: "query",

description: "ソートタイプ",

required: false,

schema: {

type: "string",

default: "title",

description: "titleまたはdateとする"

}

},

{

name: "offset",

in: "query",

description: "取得開始件数",

required: false,

schema: {

type: "integer",

format: "int32",

default: 0,

description: "数値はintとする"

}

},

{

name: "limit",

in: "query",

description: "最大取得件数",

required: false,

schema: {

type: "integer",

format: "int32",

default: 20,

16 / 20

maximum: 1000,

description: "数値はintとし最大値は1000とする"

}

}

],

responses: {

200: {

description: "JSONにて検索結果出力",

content: {

application/json: {

schema: {

$ref: "#/components/schemas/searchResource"

}

}

}

},

404: {

description: "該当データなし",

content: {

text/html: {}

}

},

405: {

description: "不正パラメータ",

content: {

text/html: {}

}

},

default: {

description: "その他エラー",

content: {

text/html: {}

}

}

},

security: [

{

http: []

}

]

}

},

/api/field: {

get: {

operationId: "fieldResource",

description: "指定された分野の取得を行う",

parameters: [

{

name: "fieldId",

in: "query",

description: "分野ID",

required: false,

schema: {

type: "string",

description: "検索する分野IDを指定する"

}

}

],

responses: {

200: {

description: "JSONにて検索結果出力",

content: {

application/json: {

schema: {

$ref: "#/components/schemas/fieldResource"

}

}

17 / 20

}

},

405: {

description: "不正パラメータ",

content: {

text/html: {}

}

},

default: {

description: "その他エラー",

content: {

text/html: {}

}

}

},

security: [

{

http: []

}

]

}

}

},

components: {

schemas: {

searchResource: {

type: "object",

properties: {

hitnum: {

type: "integer",

format: "int64"

},

recode: {

type: "array",

items: {

$ref: "#/components/schemas/recodes"

}

}

}

},

recodes: {

type: "object",

properties: {

categoryId: {

type: "string"

},

subcategoryId: {

type: "string"

},

aipId: {

type: "string"

},

metadata: {

type: "object",

items: {

$ref: "#/components/schemas/metadatas"

}

}

}

},

metadatas: {

type: "object",

additionalProperties: {

type: "string"

}

},

fieldResource: {

18 / 20

type: "object",

properties: {

fields: {

type: "array",

items: {

$ref: "#/components/schemas/fields"

}

}

}

},

fields: {

type: "object",

properties: {

fieldId: {

type: "string"

},

categories: {

type: "array",

items: {

$ref: "#/components/schemas/categories"

}

}

}

},

categories: {

type: "object",

properties: {

categoryId: {

type: "string"

},

subcategories: {

type: "array",

items: {

$ref: "#/components/schemas/subcategories"

}

}

}

},

subcategories: {

type: "object",

properties: {

subcategoryId: {

type: "string"

}

}

}

}

}

}

19 / 20

4. 参照資料

(1) 情報資源分類

No. 分野分野ID 情報資源分類情報資源分類ID 情報資源小分類情報資源小分類ID

1 マンガ manga アイテム cm-item 単行本 cm101

2 マンガ manga アイテム cm-item 雑誌巻号 cm102

3 マンガ manga アイテム cm-item マンガその他 cm103

4 マンガ manga コレクション cm-col 単行本全巻 cm104

5 マンガ manga コレクション cm-col 雑誌全号 cm105

6 アニメーション animation アイテム an-item テレビ番組 an201

7 アニメーション animation アイテム an-item ビデオパッケージ an202

8 アニメーション animation アイテム an-item 劇場上映 an205

9 アニメーション animation コレクション an-col テレビレギュラーアニメシリーズ an207

10 アニメーション animation コレクション an-col テレビ単発（スペシャル）アニメシリーズ an208

11 アニメーション animation コレクション an-col 劇場版アニメシリーズ an210

12 ゲーム game アイテム gm-item パッケージ gm301

13 ゲーム game コレクション gm-col ゲームバリエーション gm305

14 ゲーム game コレクション gm-col ゲーム作品 gm306

15 メディアアート mediaart アイテム ma-item 展示・実演 ma401

16 メディアアート mediaart コレクション ma-col メディアアート催事 ma408

20 / 20

メディア芸術データベース(ベータ版) webapi仕様...1. リソース検索 2....

Documents