ジャンプ先

• リクエスト
• レスポンス

仮想モデルの作成

put

/database/rdf/networks/{network_owner},{network_name}/virtual_models/{virtual_model_name}

仮想モデルを作成します。クライアントは、このサービスを起動するには、SQL開発者ロールまたはRDF開発者ロールが必要です。

リクエスト

パス・パラメータ

• network_name(必須): string
  RDFネットワークの名前。

  例:

  NET1

• network_owner(必須): string
  RDFネットワークの所有者。

  例:

  RDFUSER

• virtual_model_name(required): string
  仮想モデルの名前。

  例:

  VM1

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

タイプ: object

ソースの表示

• entailments: array entailments
  仮想モデルに使用する伴意のリスト(null以外にできるのは、1つのルールベースまたは伴意のみ)
• models(必須): array models
  仮想モデルに使用するモデルのリスト
• options: string
  仮想モデル作成のオプション
• rulebases: array rulebases
  仮想モデルに使用するルールベースのリスト

{
    "type":"object",
    "properties":{
        "models":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"M1"
            },
            "description":"List of models to use for the virtual model"
        },
        "rulebases":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of rulebases to use for the virtual model"
        },
        "entailments":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of entailments to use for the virtual model (only one of rulebases or entailments can be non-null)"
        },
        "options":{
            "type":"string",
            "description":"options for virtual model creation"
        }
    },
    "required":[
        "models"
    ]
}

ネストされたスキーマ: entailments

タイプ: array

仮想モデルに使用する伴意のリスト(null以外にできるのは、1つのルールベースまたは伴意のみ)

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of entailments to use for the virtual model (only one of rulebases or entailments can be non-null)"
}

ネストされたスキーマ: models

タイプ: array

仮想モデルに使用するモデルのリスト

ソースの表示

• 配列: 文字列
  例: M1

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"M1"
    },
    "description":"List of models to use for the virtual model"
}

ネストされたスキーマ: rulebases

タイプ: array

仮想モデルに使用するルールベースのリスト

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of rulebases to use for the virtual model"
}

例

例の選択 これは、モデル2つからなる仮想モデルを作成する例です。オプションREPLACE=Tは、CREATE OR REPLACEの動作の場合に使用します。 これは、モデルのセットと1つのルールベースを使用して仮想モデルを作成する例です。なお、1つの伴意を、そのモデルとルールベースの組合せに対して事前に作成しておく必要があります。 これは、モデルのセットと1つの伴意を使用して仮想モデルを作成する例です。なお、ルールベースと異なり、モデルと伴意の組合せを制限する制約はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

201レスポンス

仮想モデルが正常に作成されました。

本文 ()

ルート・スキーマ: VirtualModelDetailSingle

タイプ: object

単一仮想モデルのメタデータ。

ソースの表示

• datasets: string
  仮想モデルの構築に使用するモデル、ルールベースおよび伴意の名前のカンマ区切りリスト

  例: MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL
• duplicate_view_name: string
  仮想モデル内の重複するトリプルを含むビューの名前(ある場合)。

  例: NET1#SEMV_VM1
• links: array links
• model_count: string
  仮想モデルに含まれるモデルの数

  例: 1
• owner: string
  仮想モデルの所有者

  例: RDUSER
• rulebase_count: string
  仮想モデルに含まれるルールベースの数

  例: 1
• rules_index_count: string
  仮想モデルに含まれる伴意の数

  例: 1
• status: string
  関連する伴意が有効な場合はVALID、伴意が無効な場合はINVALID、伴意が不完全な場合はINCOMPLETE (INVALIDと似ているが再作成に必要な時間がより短い)、伴意を作成中の場合はINPROGRESS、伴意の作成中にシステム障害が発生した場合はFAILED、または仮想モデルに伴意が関連付けられていない場合はNORIDXを含みます。複数の伴意がある場合は、すべてのコンポーネント伴意のうち最下位のステータスが、仮想モデルのステータスとして使用されます(INVALID < INCOMPLETE < VALID)。

  例: VALID
• unique_view_name: string
  仮想モデル内の一意のトリプルを含むビューの名前。ビューが作成されていない場合は、NULL。

  例: NET1#SEMU_VM1
• virtual_model_name: string
  仮想モデルの名前

  例: VM1

{
    "description":"Metadata for a single virtual model.",
    "type":"object",
    "properties":{
        "owner":{
            "type":"string",
            "example":"RDUSER",
            "description":"owner of the virtual model"
        },
        "virtual_model_name":{
            "type":"string",
            "example":"VM1",
            "description":"name of the virtual model"
        },
        "unique_view_name":{
            "type":"string",
            "example":"NET1#SEMU_VM1",
            "description":"name of the view that contains unique triples in the virtual model, or null if the view was not created"
        },
        "duplicate_view_name":{
            "type":"string",
            "example":"NET1#SEMV_VM1",
            "description":"name of the view that contains duplicate triples (if any) in the virtual model"
        },
        "status":{
            "type":"string",
            "example":"VALID",
            "description":"contains VALID if the associated entailment is valid, INVALID if the entailment is not valid, INCOMPLETE if the entailment is incomplete (similar to INVALID but requiring less time to re-create), INPROGRESS if the entailment is being created, FAILED if a system failure occurred during the creation of the entailment, or NORIDX if no entailment is associated with the virtual model. In the case of multiple entailments, the lowest status among all of the component entailments is used as the virtual model's status (INVALID < INCOMPLETE < VALID)."
        },
        "model_count":{
            "type":"string",
            "example":"1",
            "description":"number of models contained in the virtual model"
        },
        "rulebase_count":{
            "type":"string",
            "example":"1",
            "description":"number of rulebases contained in the virtual model"
        },
        "rules_index_count":{
            "type":"string",
            "example":"1",
            "description":"number of entailments contained in the virtual model"
        },
        "datasets":{
            "type":"string",
            "example":"MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL",
            "description":"a comma-delimited list of the names of models, rulebases and entailments used to build the virtual model"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

400 レスポンス

名前が同一かモデルとルールベースと伴意の組合せが同一の仮想モデルがすでに存在するか、指定されたモデルとルールベースの組合せに対して伴意が存在しません

404レスポンス

RDFネットワークが存在しないか、参照されているモデル、ルールベースまたは伴意のいずれかが存在しません

先頭に戻る