REST API リファレンス

リソース値

主要な「リソース」タイプ（アイテム、アイテムセット、メディア）は、ユーザ編集可能なメタデータを「リソース値」として保存しています。

すべての値には関連するデータタイプがあり、これはウェブ UI での値の表示方法、データベース内での保存方法、そして JSON-LD へのレンダリングおよび取り込み方法を決定します。

Omeka S API の JSON-LD では、リソース値はオブジェクトの「トップレベル」配列として表現されます。この各オブジェクトはそれぞれ単一の値を代表します：

{
  "dcterms:title": [
    {
      "type": "literal",
      "property_id": 1,
      "property_label": "タイトル",
      "is_public": true,
      "@value": "最初の例タイトル"
    },
    {
      "type": "literal",
      "property_id": 1,
      "property_label": "タイトル",
      "is_public": true,
      "@value": "二番目の例タイトル"
    }
  ]
}

REST API により出力される値はプロパティごとにグループ化されます（上記の例でのトップレベルのdcterms:titleキーに注意してください）。

一般的な値のプロパティ

いくつかのオブジェクトプロパティはすべてのデータタイプに共通しています：

type: (必須, 文字列) 値のデータタイプを宣言します。組み込みのタイプにはliteral, uri, resource, resource:item, resource:itemset, resource:mediaなどがあり、モジュールによって追加されたりします。
property_id: (必須, 数字または文字列) この値に関連付けられたプロパティの内部 Omeka S ID です。プロパティ ID は API 出力から再利用したり、api/propertiesエンドポイントを通じて発見することができます。 Omeka S 4.0.0 以降では、ここで文字列autoを渡すと、配列のキーで使用された用語にマッチするプロパティを使用します（つまり、上記の例では、dcterms:titleの正しいプロパティ ID を探して使用します）。
is_public: (ブール) この値がプライベート（リソースの作成者と高レベルの権限を持つユーザーにのみ見える）とマークされているかどうか。入力時にこのプロパティが提供されない場合、値は公開とマークされます。
property_label: (読み取り専用, 文字列) 関連プロパティの人間に読みやすい名前です。これは消費者の便宜のために JSON 出力に含まれていますが、入ってくるデータでは完全に無視されます。

リテラル値のプロパティ

リテラル値（タイプliteral）はプレーンテキストです。

@value: (必須, 文字列) 値のテキスト。
@language: (文字列) このテキストの言語。言語はBCP 47コードとして指定するべきです。

URI 値のプロパティ

URI 値（タイプuri）は Omeka S システム外の他のリソースへのリンクを表します。

@id (必須, 文字列) リンクされている URI。
o:label: (文字列) リンクのための人間に読みやすいラベルで、ウェブ UI でのリンクテキストとして表示されます。

リソース値のプロパティ

リソース値は同じ Omeka S インストール内の他のリソースへのリンクを表します。メインタイプresourceはアイテムやセットへのリンクになることができ、一方でresource:item, resource:itemset, resource:mediaはそれぞれの値がアイテム、アイテムセット、メディアだけにリンクすることを制限します。

value_resource_id (必須, 数字) リンクされているリソースの内部 Omeka S ID。リソース ID は、全てのリソースに対して API 出力でo:idとして公開されています。

API への入力としてvalue_resource_idのみが使用されますが、消費者の便宜のため、いくつかのプロパティが出力に含まれています：

@id (読み取り専用, 文字列) リンクされているリソースの API URL。
value_resource_name (読み取り専用, 文字列) リンクされているリソースの種類の名前。
display_title (読み取り専用, 文字列) リンクされているリソースのタイトル。
thumbnail_url, thumbnail_title, thumbnail_type (読み取り専用, 文字列) リンクされたリソースにメディアが関連付けられている場合にのみ存在します。それぞれ、スクエアサムネイルのための URL、サムネイルのためのメディアのタイトル、そのメディアのタイプです。
url (読み取り専用, 文字列) リソースの URL。この値は API 出力ではnullです；実際の URL は、 JSON 出力がウェブページビューに組み込まれたときのみ提供されます。