Jump to

• Request
• Response

Create virtual model

put

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

Creates a virtual model. A client requires SQL Developer or RDF Developer role to invoke this servce.

Request

Path Parameters

• network_name(required): string
  The name of the RDF network.

  Example:

  NET1

• network_owner(required): string
  The owner of the RDF network.

  Example:

  RDFUSER

• virtual_model_name(required): string
  The name of the virtual model.

  Example:

  VM1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• entailments: array entailments
  List of entailments to use for the virtual model (only one of rulebases or entailments can be non-null)
• models(required): array models
  List of models to use for the virtual model
• options: string
  options for virtual model creation
• rulebases: array rulebases
  List of rulebases to use for the virtual model

{
    "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"
    ]
}

Nested Schema : entailments

Type: array

List of entailments to use for the virtual model (only one of rulebases or entailments can be non-null)

Show Source

• Array of: string

{
    "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)"
}

Nested Schema : models

Type: array

List of models to use for the virtual model

Show Source

• Array of: string
  Example: M1

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

Nested Schema : rulebases

Type: array

List of rulebases to use for the virtual model

Show Source

• Array of: string

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

Examples

Select an example This is an example of creating a virtual model consisting of two models. Option REPLACE=T is used for CREATE OR REPLACE behavior. This is an example of creating a virtual model with a set of models and a rulebase. Note that an entailment must be pre-created for the model-rulebase combination. This is an example of creating a virtual model with a set of models and an entailment. Note that, unlike rulebases, there no constraints limiting model and entailment combinations.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful virtual model creation.

Body ()

Root Schema : VirtualModelDetailSingle

Type: object

Metadata for a single virtual model.

Show Source

• datasets: string
  a comma-delimited list of the names of models, rulebases and entailments used to build the virtual model

  Example: MODEL M1, RULEBASE OWLPRIME, RULEIDX M1OWL
• duplicate_view_name: string
  name of the view that contains duplicate triples (if any) in the virtual model

  Example: NET1#SEMV_VM1
• links: array links
• model_count: string
  number of models contained in the virtual model

  Example: 1
• owner: string
  owner of the virtual model

  Example: RDUSER
• rulebase_count: string
  number of rulebases contained in the virtual model

  Example: 1
• rules_index_count: string
  number of entailments contained in the virtual model

  Example: 1
• status: string
  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).

  Example: VALID
• unique_view_name: string
  name of the view that contains unique triples in the virtual model, or null if the view was not created

  Example: NET1#SEMU_VM1
• virtual_model_name: string
  name of the virtual model

  Example: 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"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

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

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

400 Response

A virtual model with the same name or the same model-rulebase-entailment combination already exists or no entailment exists for the given model-rulebase combination

404 Response

RDF network does not exist or one of the referenced models, rulebases, or entailments does not exist

Back to Top