Jump to

• Request
• Response

List entailments

get

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

Returns metadata describing all entailments 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 entailments in the specified network.

Body ()

Root Schema : EntailmentDetailCollection

Type: object

A collection of RDF entailment metadata items.

Show Source

• items: array items
• links: array links

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

Nested Schema : items

Type: array

Show Source

• Array of: object EntailmentDetailSingle
  This object represents metadata about an RDF entailment.

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : EntailmentDetailSingle

Type: object

This object represents metadata about an RDF entailment.

Show Source

• datasets: string
  a comma-delimited list of the names of models and rulebases used to build the entailment

  Example: MODEL M1, RULEBASE OWLPRIME
• index_name: string
  the name of the entailment

  Example: M1OWL
• index_view_name: string
  the name of the database view that contains the entailed triples

  Example: NET1#RDFI_M1OWL
• links: array links
• model_count: string
  the number of models used to build the entailment

  Example: 1
• owner: string
  the owner of the entailment

  Example: RDFUSER
• rulebase_count: string
  the number of rulebases used to build the entailment

  Example: 1
• status: string
  the status of the entailment (VALID if the 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, or FAILED if a system failure occurred during the creation of the entailment)

  Example: VALID

{
    "type":"object",
    "description":"This object represents metadata about an RDF entailment.",
    "properties":{
        "owner":{
            "type":"string",
            "example":"RDFUSER",
            "description":"the owner of the entailment"
        },
        "index_name":{
            "type":"string",
            "example":"M1OWL",
            "description":"the name of the entailment"
        },
        "index_view_name":{
            "type":"string",
            "example":"NET1#RDFI_M1OWL",
            "description":"the name of the database view that contains the entailed triples"
        },
        "status":{
            "type":"string",
            "example":"VALID",
            "description":"the status of the entailment (VALID if the 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, or FAILED if a system failure occurred during the creation of the entailment)"
        },
        "model_count":{
            "type":"string",
            "example":1,
            "description":"the number of models used to build the entailment"
        },
        "rulebase_count":{
            "type":"string",
            "example":1,
            "description":"the number of rulebases used to build the entailment"
        },
        "datasets":{
            "type":"string",
            "example":"MODEL M1, RULEBASE OWLPRIME",
            "description":"a comma-delimited list of the names of models and rulebases used to build the entailment"
        },
        "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