Jump to

• Request
• Response

RDF network information

get

http://localhost:8080/ords/pdbdba/_/db-api/stable/database/rdf/networks/{network_owner},{network_name}

Returns metadata describing the specified 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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns metadata about the specified network.

Body ()

Root Schema : NetworkDetailElem

Type: object

Metadata for an RDF network.

Show Source

• links: array links
• network_name: string
  the name of the RDF network

  Example: NET1
• owner: string
  the owner of the RDF network

  Example: RDFUSER
• parameters: array parameters

{
    "description":"Metadata for an RDF network.",
    "type":"object",
    "properties":{
        "owner":{
            "type":"string",
            "example":"RDFUSER",
            "description":"the owner of the RDF network"
        },
        "network_name":{
            "type":"string",
            "example":"NET1",
            "description":"the name of the RDF network"
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NetworkParameterElem"
            }
        },
        "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 : parameters

Type: array

Show Source

• Array of: object NetworkParameterElem
  This object represents a metadata attribute and value.

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

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

Nested Schema : NetworkParameterElem

Type: object

This object represents a metadata attribute and value.

Show Source

• attribute: string
  the attribute name

  Example: COMPRESSION
• description: string
  a description of the attribute

  Example: Compression setting for semantic network
• namespace: string
  the attribute category

  Example: NETWORK
• value: string
  the attribute value

  Example: COMPRESS=RSCB

{
    "type":"object",
    "description":"This object represents a metadata attribute and value.",
    "properties":{
        "namespace":{
            "type":"string",
            "example":"NETWORK",
            "description":"the attribute category"
        },
        "attribute":{
            "type":"string",
            "example":"COMPRESSION",
            "description":"the attribute name"
        },
        "value":{
            "type":"string",
            "example":"COMPRESS=RSCB",
            "description":"the attribute value"
        },
        "description":{
            "type":"string",
            "example":"Compression setting for semantic network",
            "description":"a description of the attribute"
        }
    }
}

404 Response

RDF network does not exist

Back to Top