ヘルプ

Web API

各種システムがシームレスに文字情報基盤データベースを扱えるよう、以下の4種類のAPIを提供しています。


文字情報検索API (SPARQL Endpoint)

リクエストサンプル

Request URL

  • /sparql

    Request Headers

  • Content-Type
    • application/x-www-form-urlencoded; charset=UTF-8

      POST Form Data

      query=PREFIX+mjp%3A%3Chttp%3A%2F%2Fmojikiban.ipa.go.jp%2Fterms%2Fprop%2F%3E%0ASELECT+*+WHERE%0A%7B%0A++%3Fs+%3Fp+%3Fo+.%0A%7D%0A%0ALIMIT+500%0A&format=application%2Fsparql-results%2Bxml&timeout=10

Request URL

  • /sparql

Request Method

  • POST

Request Headers

  • Content-Type
    • application/x-www-form-urlencoded; charset=UTF-8

Form Data

SPARQLクエリ

  • オプション名=query
    • Require: 必須
    • UTF-8によるURLエンコードされたSPARQLクエリ
    • 全検索 (500件まで取得)
      query=PREFIX+mjp%3A%3Chttp%3A%2F%2Fmojikiban.ipa.go.jp%2Fterms%2Fprop%2F%3E%0ASELECT+*+WHERE%0A%7B%0A++%3Fs+%3Fp+%3Fo+.%0A%7D%0A%0ALIMIT+500%0A

レスポンスフォーマット

  • オプション名=format
    • Require: オプション無指定でapplication/sparql-results+json
    • application/sparql-results+xml
    • application/sparql-results+json
    • text/csv|text/tab-separated-values
    • application/rdf+xml
    • text/turtle
    • application/sparql-results+xmlでリクエストする場合
      • format=application%2Fsparql-results%2Bxml

タイムアウト秒数

  • オプション名= timeout

    • Require: オプション 無指定でシステムパラメータ定義デフォルトタイムアウト秒、設定可能最大値はシステムパラメータ定義リミットタイムアウト秒
    • 1秒でタイムアウト
      query=PREFIX+mjp%3A%3Chttp%3A%2F%2Fmojikiban.ipa.go.jp%2Fterms%2Fprop%2F%3E%0ASELECT+*+WHERE%0A%7B%0A++%3Fs+%3Fp+%3Fo+.%0A%7D%0A%0ALIMIT+500%0A&timeout=1

文字情報取得API

リクエストサンプル (GET)

Request URL

  • /data/MJ/MJ000001-MJ000010?date=2011-10-01

    Request Headers

  • Content-Type
    • application/x-www-form-urlencoded; charset=UTF-8

リクエストサンプル (POST)

Request URL

  • /data/MJ/

    Request Headers

  • Content-Type
    • application/x-www-form-urlencoded; charset=UTF-8

      POST Form Data

      MJNames=MJ000001-MJ000010

Request URL

  • /data/MJ/

Request Method

  • GET|POST
    • POSTの場合はJSONのみ

Request Headers

  • Content-Type
    • application/x-www-form-urlencoded; charset=UTF-8

Form Data (GET)

MJ文字図形名

  • オプション名なし
    • Require: オプション
    • MJ文字図形名とカンマ区切りの複数指定、ハイフン区切りの範囲指定が可能
    • MJ000001 から MJ000010までを取得
      • /data/MJ/MJ000001-MJ000010
    • MJ000001 と MJ000010を取得
      • /data/MJ/MJ000001,MJ000010

レスポンスフォーマット

  • オプション名=拡張子
    • Require: オプション無指定で整形済みJSON
拡張子 レスポンスフォーマット
なし 整形済みJSON
.rdf describe で取得した RDF
.json describe で取得した JSON
.ttl describe で取得した ttl
    • MJ000001 から MJ000010までを整形済みJSONで取得
      • /data/MJ/MJ000001-MJ000010
    • MJ000001 から MJ000010までをapplication/rdf+xmlで取得
      • /data/MJ/MJ000001-MJ000010.rdf
    • MJ000001 から MJ000010までをdescribe JSONで取得
      • /data/MJ/MJ000001-MJ000010.json
    • MJ000001 から MJ000010までをdescribe ttlで取得
      • /data/MJ/MJ000001-MJ000010.ttl

指定日付以降に変更のあったMJ文字図形名を対象とするオプション

  • オプション名: date
    • Require: オプション 無指定で2011-05-16
    • YYYY-MM-DD
    • YYYY-MM
    • YYYY

※ハイフンの有無は問わない ※DDを指定しない場合はその月の1日が定義される ※MMを指定しない場合はその年の1月1日が定義される

    • MJ000315 から MJ000324までをdescribe JSONで取得、2011-05-18以降に変更のあったMJ文字図形名のみ対象とする
      • /data/MJ/MJ000315-MJ000324.json?date=2011-05-18

Form Data (POST)

MJ文字図形名

  • オプション名=MJNames
    • Require: 必須
    • MJ文字図形名とカンマ区切りの複数指定、ハイフン区切りの範囲指定が可能
    • MJ000001 から MJ000010までを取得
      • MJNames=MJ000001-MJ000010
    • MJ000001 と MJ000010を取得
      • MJNames=MJ000001,MJ000010

指定日付以降に変更のあったMJ文字図形名を対象とするオプション

  • オプション名: date
    • Require: オプション 無指定で2011-05-16
    • YYYY-MM-DD
    • YYYY-MM
    • YYYY

※ハイフンの有無は問わない ※DDを指定しない場合はその月の1日が定義される ※MMを指定しない場合はその年の1月1日が定義される

    • MJ000315 から MJ000324までを取得、2011-05-18以降に変更のあったMJ文字図形名のみ対象とする
      • Request URL
        • /data/MJ/?date=2011-05-18
      • POST Form Data
        • MJNames=MJ000315-MJ000324

文字画像取得API

リクエストサンプル

Request URL

  • /img/MJ/MJ000001.png
  • /img/MJ/MJ000001-MJ000011.png
  • /img/MJ/MJ000009.svg
  • /img/MJ/MJ000001-MJ000011.svg

Request URL

  • /img/MJ/

Request Method

  • GET

Form Data (GET)

MJ文字図形名

  • オプション名なし
    • Require: 必須
    • MJ文字図形名とカンマ区切りの複数指定、ハイフン区切りの範囲指定が可能 ※2個以上の画像が リクエストされた場合はzipに圧縮してレスポンスされる
    • MJ000001 を取得
      • /img/MJ/MJ000001
    • MJ000001 と MJ000010を取得
      • /img/MJ/MJ000001,MJ000010

レスポンスフォーマット

  • オプション名=拡張子
    • Require: オプション無指定でPNG
拡張子 レスポンスフォーマット
なし PNG
.png PNG
.svg SVG
    • MJ000001 から MJ000010までをPNGで取得
      • /img/MJ/MJ000001-MJ000010
    • MJ000010 から MJ000011までをPNGで取得
      • /img/MJ/MJ000010-MJ000011.png
    • MJ000001 から MJ000010までをSVGで取得
      • /img/MJ/MJ000001-MJ000010.svg

※PNGにありSVGにない画像があるため、SVGの範囲指定で存在しない画像はZIPに内包されるテキストに記載される。


文字更新確認API

リクエストサンプル

Request URL

  • /data/MJ/modify/MJ000315-MJ000324?date=2011-05-18
  • /data/MJ/modify/MJ000315-MJ000324.xml?date=2011-05-18

Request URL

  • /data/MJ/modify/

Request Method

  • GET

Form Data (GET)

MJ文字図形名

  • オプション名なし
    • Require: オプション 無指定で全件が対象
    • MJ文字図形名とカンマ区切りの複数指定、ハイフン区切りの範囲指定が可能
    • MJ000001 を取得
      • /data/MJ/modify/MJ000001
    • MJ000001 と MJ000010を取得
      • /data/MJ/modify/MJ000001,MJ000010

レスポンスフォーマット

  • オプション名=拡張子
    • Require: オプション無指定でJSON
拡張子 レスポンスフォーマット
なし JSON
.xml XML
    • MJ000001 から MJ000010までをJSONで取得
      • /data/MJ/modify/MJ000001-MJ000010
    • MJ000010 から MJ000011までをXMLで取得
      • /data/MJ/modify/MJ000001-MJ000010.xml

対象更新日付指定

  • オプション名: date
    • Require: オプション 無指定で2011-05-16
    • YYYY-MM-DD
    • YYYY-MM
    • YYYY

※ハイフンの有無は問わない ※DDを指定しない場合はその月の1日が定義される ※MMを指定しない場合はその年の1月1日が定義される

    • MJ000315 から MJ000324までを取得、2011-05-18以降に変更があったかどうか確認する
      • Request URL
        • /data/MJ/modify/MJ000315-MJ000324?date=2011-05-18