Jump to

• Request
• Response

Get all arguments for functions and procedures

get

/database/objects/arguments/

Returns all records from DBA_ARGUMENTS or ALL_ARGUMENTS 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

All records from DBA_ARGUMENTS.

Body ()

Root Schema : DatabaseArguments

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/DatabaseArgumentsItem"
            }
        },
        "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 DatabaseArgumentsItem
  This object represents arguments of the functions and procedures that are available in the database. The list of attributes may vary depending on database version.

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : DatabaseArgumentsItem

Type: object

This object represents arguments of the functions and procedures that are available in the database. The list of attributes may vary depending on database version.

Show Source

• argument_name: string
  If the argument is a scalar type, then the argument name is the name of the argument. A null argument name is used to denote a function return. If the function return or argument is a composite type, this view will have one row for each attribute of the composite type. Attributes are recursively expanded if they are composite.
• char_length: integer
  Character limit for string datatypes.
• char_used: string
  Indicates whether the byte limit (B) or char limit (C) is official for the string.
• character_set_name: string
  Character set name for the argument.
• data_length: integer
  Length of the column (in bytes).
• data_level: integer
  Nesting depth of the argument for composite types.
• data_precision: integer
  Length in decimal digits (NUMBER) or binary digits (FLOAT).
• data_scale: integer
  Digits to the right of the decimal point in a number.
• data_type: string
  Datatype of the argument.
• default_length: integer
  Reserved for future use.
• default_value: integer
  Reserved for future use.
• defaulted: string
  Specifies whether or not the argument is defaulted.
• in_out: string
  Direction of the argument: IN, OUT, IN/OUT.
• links: array links
• object_id: integer
  Dictionary object number of the object.
• object_name: string
  Name of the procedure or function.
• origin_con_id: integer
  The ID of the container where the data originates.
• overload: string
  Indicates the nth overloading ordered by its appearance in the source; otherwise, it is NULL.
• owner: string
  Owner of the object.
• package_name: string
  Name of the package.
• pls_type: string
  For numeric arguments, the name of the PL/SQL type of the argument. Null otherwise.
• position: integer
  If DATA_LEVEL is zero, then this column holds the position of this item in the argument list, or zero for a function return value.If DATA_LEVEL is greater than zero, then this column holds the position of this item with respect to its siblings at the same DATA_LEVEL. So, for a referenced record field, this is the index of the field within the record. For a referenced collection element, this is 1 (because collection elements do not have siblings.)
• radix: integer
  Argument radix for a number.
• sequence: integer
  Defines the sequential order of the argument and its attributes. Argument sequence starts from 1. Return type and its recursively expanded (preorder tree walk) attributes will come first, and each argument with its recursively expanded (preorder tree walk) attributes will follow.
• subprogram_id: integer
  Unique subprogram identifier.
• type_link: string
  Relevant only for package local types when the package identified in the TYPE_NAME column is a remote package. This column displays the database link used to refer to the remote package.
• type_name: string
  Name of the type of the argument. If the type is a package local type (that is, it is declared in a package specification), then this column displays the name of the package.
• type_object_type: string
  Displays the type of the type described by the TYPE_OWNER, TYPE_NAME, and TYPE_SUBNAME columns.
• type_owner: string
  Owner of the type of the argument.
• type_subname: string
  Relevant only for package local types. Displays the name of the type declared in the package identified in the TYPE_NAME column.

{
    "type":"object",
    "description":"This object represents arguments of the functions and procedures that are available in the database. The list of attributes may vary depending on database version.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the object."
        },
        "object_name":{
            "type":"string",
            "description":"Name of the procedure or function."
        },
        "package_name":{
            "type":"string",
            "description":"Name of the package."
        },
        "object_id":{
            "type":"integer",
            "description":"Dictionary object number of the object."
        },
        "overload":{
            "type":"string",
            "description":"Indicates the nth overloading ordered by its appearance in the source; otherwise, it is NULL."
        },
        "subprogram_id":{
            "type":"integer",
            "description":"Unique subprogram identifier."
        },
        "argument_name":{
            "type":"string",
            "description":"If the argument is a scalar type, then the argument name is the name of the argument. A null argument name is used to denote a function return. If the function return or argument is a composite type, this view will have one row for each attribute of the composite type. Attributes are recursively expanded if they are composite."
        },
        "position":{
            "type":"integer",
            "description":"If DATA_LEVEL is zero, then this column holds the position of this item in the argument list, or zero for a function return value.If DATA_LEVEL is greater than zero, then this column holds the position of this item with respect to its siblings at the same DATA_LEVEL. So, for a referenced record field, this is the index of the field within the record. For a referenced collection element, this is 1 (because collection elements do not have siblings.)"
        },
        "sequence":{
            "type":"integer",
            "description":"Defines the sequential order of the argument and its attributes. Argument sequence starts from 1. Return type and its recursively expanded (preorder tree walk) attributes will come first, and each argument with its recursively expanded (preorder tree walk) attributes will follow."
        },
        "data_level":{
            "type":"integer",
            "description":"Nesting depth of the argument for composite types."
        },
        "data_type":{
            "type":"string",
            "description":"Datatype of the argument."
        },
        "defaulted":{
            "type":"string",
            "description":"Specifies whether or not the argument is defaulted."
        },
        "default_value":{
            "type":"integer",
            "description":"Reserved for future use."
        },
        "default_length":{
            "type":"integer",
            "description":"Reserved for future use."
        },
        "in_out":{
            "type":"string",
            "description":"Direction of the argument: IN, OUT, IN/OUT."
        },
        "data_length":{
            "type":"integer",
            "description":"Length of the column (in bytes)."
        },
        "data_precision":{
            "type":"integer",
            "description":"Length in decimal digits (NUMBER) or binary digits (FLOAT)."
        },
        "data_scale":{
            "type":"integer",
            "description":"Digits to the right of the decimal point in a number."
        },
        "radix":{
            "type":"integer",
            "description":"Argument radix for a number."
        },
        "character_set_name":{
            "type":"string",
            "description":"Character set name for the argument."
        },
        "type_owner":{
            "type":"string",
            "description":"Owner of the type of the argument."
        },
        "type_name":{
            "type":"string",
            "description":"Name of the type of the argument. If the type is a package local type (that is, it is declared in a package specification), then this column displays the name of the package."
        },
        "type_subname":{
            "type":"string",
            "description":"Relevant only for package local types. Displays the name of the type declared in the package identified in the TYPE_NAME column."
        },
        "type_link":{
            "type":"string",
            "description":"Relevant only for package local types when the package identified in the TYPE_NAME column is a remote package. This column displays the database link used to refer to the remote package."
        },
        "type_object_type":{
            "type":"string",
            "description":"Displays the type of the type described by the TYPE_OWNER, TYPE_NAME, and TYPE_SUBNAME columns."
        },
        "pls_type":{
            "type":"string",
            "description":"For numeric arguments, the name of the PL/SQL type of the argument. Null otherwise."
        },
        "char_length":{
            "type":"integer",
            "description":"Character limit for string datatypes."
        },
        "char_used":{
            "type":"string",
            "description":"Indicates whether the byte limit (B) or char limit (C) is official for the string."
        },
        "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