Jump to

• Request
• Response

Get all synonyms in the database

get

/database/objects/synonyms/

Returns all records on DBA_SYNONYMS or ALL_SYNONYMS view 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, using DBA_SYNONYMS or ALL_SYNONYMS view, all synonyms in the database.

Body ()

Root Schema : DatabaseObjectsSynonyms

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/DatabaseObjectsSynonymsItem"
            }
        },
        "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 DatabaseObjectsSynonymsItem
  This object describes a synonym in the database. The list of attributes may vary depending on database version.

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : DatabaseObjectsSynonymsItem

Type: object

This object describes a synonym in the database. The list of attributes may vary depending on database version.

Show Source

• db_link: string
  Name of the database link referenced, if any.
• links: array links
• origin_con_id: integer
  The ID of the container where the data originates.
• owner: string
  Owner of the synonym.
• synonym_name: string
  Name of the synonym.
• table_name: string
  Name of the object referenced by the synonym. Although the column is called TABLE_NAME, the object does not necessarily have to be a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on.
• table_owner: string
  Owner of the object referenced by the synonym, or creator of the referring synonym if the target is a public synonym (that is, the object referred to by TABLE_NAME). Although the column is called TABLE_OWNER, the object owned is not necessarily a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on.

{
    "type":"object",
    "description":"This object describes a synonym in the database. The list of attributes may vary depending on database version.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the synonym."
        },
        "synonym_name":{
            "type":"string",
            "description":"Name of the synonym."
        },
        "table_owner":{
            "type":"string",
            "description":"Owner of the object referenced by the synonym, or creator of the referring synonym if the target is a public synonym (that is, the object referred to by TABLE_NAME). Although the column is called TABLE_OWNER, the object owned is not necessarily a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on."
        },
        "table_name":{
            "type":"string",
            "description":"Name of the object referenced by the synonym. Although the column is called TABLE_NAME, the object does not necessarily have to be a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on."
        },
        "db_link":{
            "type":"string",
            "description":"Name of the database link referenced, if any."
        },
        "origin_con_id":{
            "type":"integer",
            "description":"The ID of the container where the data originates."
        },
        "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"
    ]
}

Back to Top