Jump to

• Request
• Response

List virtual models

get

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

Returns metadata describing all virtual models in the network. The exact attributes returned may vary depending on the Database version. A client requires SQL Developer, RDF Developer or RDF Reader 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

Query Parameters

• limit: integer(int32)
  The maximum number of records to return.
• offset: integer(int32)
  The index of the first record to start returning results for. Used with pagination.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns an array of elements containing metadata about all virtual models in the specified network.

Body ()

Root Schema : VirtualModelDetailCollection

Type: object

A collection of RDF virtual model metadata items.

Show Source

• items: array items
• links: array links

{
    "description":"A collection of RDF virtual model metadata items.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VirtualModelDetailSingle"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object VirtualModelDetailSingle
  Metadata for a single virtual model.

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

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

404 Response

RDF network does not exist

Back to Top