Jump to

• Request
• Response

Get all foreign keys

get

/database/objects/foreign_keys/

Returns all records where the constraint type is 'R' from DBA_CONSTRAINTS and DBA_CONS_COLUMNS, or ALL_CONSTRAINTS and ALL_CONS_COLUMNS, views depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.

Request

Query Parameters

• limit: integer(int32)
  The maximum number of records to return.
• q:
  Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.

  Examples

  Select an example FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Describes all constraint definitions, with constraint type 'R', on all tables in the database.

Body ()

Root Schema : DatabaseObjectsForeignKeys

Type: object

Show Source

• count: integer
  Total number of records in the current response.
• hasMore: boolean
  Indicates if there are more records to be retrieved.
• items: array items
• limit: integer
  The actual page size limit on number of records applied by the server.
• links: array links
• offset: integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatabaseObjectsForeignKeysItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DatabaseObjectsForeignKeysItem
  Describes a foreign key constraint for referential integrity.

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : DatabaseObjectsForeignKeysItem

Type: object

Describes a foreign key constraint for referential integrity.

Show Source

• columns: object columns
  Describes all the columns that make reference to owner, constraint_name.
• constraint_name: string
  Owner of the constraint definition.
• constraint_type: string
  Type of constraint.
• links: array links
• owner: string
  Owner of the constraint definition.
• r_constraint_name: string
  Owner of the constraint definition.
• r_owner: string
  Owner of the table referred to in a referential constraint.
• table_name: string
  Name associated with the table (or view) with the constraint definition.

{
    "type":"object",
    "description":"Describes a foreign key constraint for referential integrity.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "constraint_name":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "constraint_type":{
            "type":"string",
            "description":"Type of constraint."
        },
        "table_name":{
            "type":"string",
            "description":"Name associated with the table (or view) with the constraint definition."
        },
        "r_owner":{
            "type":"string",
            "description":"Owner of the table referred to in a referential constraint."
        },
        "r_constraint_name":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "columns":{
            "type":"object",
            "description":"Describes all the columns that make reference to  owner, constraint_name.",
            "properties":{
                "r_column_name":{
                    "type":"string",
                    "description":"Name of the column referred to in a referential constraint."
                },
                "r_table_name":{
                    "type":"string",
                    "description":"Name of the table referred to in a referential constraint."
                },
                "column_name":{
                    "type":"string",
                    "description":"Name of the column or attribute of the object type column specified in the constraint definition."
                },
                "position":{
                    "type":"integer",
                    "description":"The position of the column_name and referenced r_column_name."
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : columns

Type: object

Describes all the columns that make reference to owner, constraint_name.

Show Source

• column_name: string
  Name of the column or attribute of the object type column specified in the constraint definition.
• position: integer
  The position of the column_name and referenced r_column_name.
• r_column_name: string
  Name of the column referred to in a referential constraint.
• r_table_name: string
  Name of the table referred to in a referential constraint.

{
    "type":"object",
    "description":"Describes all the columns that make reference to  owner, constraint_name.",
    "properties":{
        "r_column_name":{
            "type":"string",
            "description":"Name of the column referred to in a referential constraint."
        },
        "r_table_name":{
            "type":"string",
            "description":"Name of the table referred to in a referential constraint."
        },
        "column_name":{
            "type":"string",
            "description":"Name of the column or attribute of the object type column specified in the constraint definition."
        },
        "position":{
            "type":"integer",
            "description":"The position of the column_name and referenced r_column_name."
        }
    }
}

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

Back to Top