Jump to

• Request
• Response

Create entailment

put

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

Creates an entailment. A client requires SQL Developer or RDF Developer role to invoke this servce.

Request

Path Parameters

• entailment_name(required): string
  The name of the entailment.

  Example:

  M1OWL

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

  Example:

  NET1

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

  Example:

  RDFUSER

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• inf_components: array inf_components
  List of keywords representing inference components, for performing selective or component-based inferencing (the default is all components defined by the included rulebases)
• models(required): array models
  List of models to use for the entailment
• options: string
  A comma-delimited string of options to control the inference process by overriding the default inference behavior
• rulebases(required): array rulebases
  List of rulebases to use for the entailment

{
    "type":"object",
    "properties":{
        "models":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of models to use for the entailment"
        },
        "rulebases":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"OWLPRIME"
            },
            "description":"List of rulebases to use for the entailment"
        },
        "inf_components":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of keywords representing inference components, for performing selective or component-based inferencing (the default is all components defined by the included rulebases)"
        },
        "options":{
            "type":"string",
            "description":"A comma-delimited string of options to control the inference process by overriding the default inference behavior"
        }
    },
    "required":[
        "models",
        "rulebases"
    ]
}

Nested Schema : inf_components

Type: array

List of keywords representing inference components, for performing selective or component-based inferencing (the default is all components defined by the included rulebases)

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of keywords representing inference components, for performing selective or component-based inferencing (the default is all components defined by the included rulebases)"
}

Nested Schema : models

Type: array

List of models to use for the entailment

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of models to use for the entailment"
}

Nested Schema : rulebases

Type: array

List of rulebases to use for the entailment

Show Source

• Array of: string
  Example: OWLPRIME

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"OWLPRIME"
    },
    "description":"List of rulebases to use for the entailment"
}

Examples

Select an example This is an example of creating an entailment using an ontology model (TBOX), a data model (ABOX), and the OWL2RL rulebase. This is an example of creating an OWL2 RL entailment using a degree of parallelism of 16 and without generating extra assertions for individuals based on owl:sameAs.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful entailment creation.

Body ()

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

400 Response

A valid entailment already exists with the same name or with the same model-rulebase combination

404 Response

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

Back to Top