Jump to

• Request
• Response

Update a specific PDB

patch

/database/pdbs/{pdb_name}

This includes unplug, open, or close a PDB. Unplug operation has a significant impact on the specified pluggable databases. The unplug operation can delete the PDB. The use of Oracle Transparent Data Encryption is only supported in topologies where the database and Oracle REST Data Services are on the same host. This service requires db.cdb.admin user credentials to be set in the pool configuration. ORA-errors need to be reviewed by the user. A client requires SQL administrator role to invoke this service.

Request

Path Parameters

• pdb_name(required): string
  Name of the Pluggable Database to open, close or unplug.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• drop_pdb: boolean
  Relevant for Unplug operations, if it is true, this will drop the pdb after unplug operation.
• dryrun: boolean
  If defined, the response will contain a JSON object with the information of the script that was generated for execution. No action is taken when this property is true and only the script text is returned.
• force: boolean
  Relevant for open/close pdb operations, Specify this keyword to change the open mode of a PDB from READ WRITE to READ ONLY, or from READ ONLY to READ WRITE. The FORCE keyword allows users to remain connected to the PDB while the open mode is changed.
• immediate: boolean
  Relevant for close pdb operations, If it is true, then this is the PDB equivalent of the SQL*Plus SHUTDOWN command with the immediate mode. Otherwise, the PDB is shut down with the normal mode
• instances: string
  Relevant for open/close pdb operations, specify one or more instance names, in a comma-separated list enclosed in parenthesis. This modifies the state of the PDB only in those instances.

  Example: ALL
• read_only: boolean
  Relevant for open pdb operations, change the open mode to READ ONLY.
• read_write: boolean
  Relevant for open pdb operations, change the open mode to READ WRITE.
• restricted: boolean
  Relevant for open pdb operations, If it is true, then the PDB is accessible only to users with the RESTRICTED SESSION privilege in the PDB.
• state: string
  Allowed Values: [ "OPEN", "CLOSE" ]

  Relevant for open/close pdb operations, the target state of the PDB.
• unplug_file_name: string
  Relevant for Unplug operations, the full path name of the operating system file in which to store information about the PDB.

{
    "type":"object",
    "properties":{
        "unplug_file_name":{
            "type":"string",
            "description":"Relevant for Unplug operations, the full path name of the operating system file in which to store information about the PDB."
        },
        "drop_pdb":{
            "type":"boolean",
            "description":"Relevant for Unplug operations, if it is true, this will drop the pdb after unplug operation."
        },
        "state":{
            "type":"string",
            "description":"Relevant for open/close pdb operations, the target state of the PDB.",
            "enum":[
                "OPEN",
                "CLOSE"
            ]
        },
        "read_only":{
            "type":"boolean",
            "description":"Relevant for open pdb operations, change the open mode to READ ONLY."
        },
        "read_write":{
            "type":"boolean",
            "description":"Relevant for open pdb operations, change the open mode to READ WRITE."
        },
        "restricted":{
            "type":"boolean",
            "description":"Relevant for open pdb operations, If it is true, then the PDB is accessible only to users with the RESTRICTED SESSION privilege in the PDB."
        },
        "force":{
            "type":"boolean",
            "description":"Relevant for open/close pdb operations, Specify this keyword to change the open mode of a PDB from READ WRITE to READ ONLY, or from READ ONLY to READ WRITE. The FORCE keyword allows users to remain connected to the PDB while the open mode is changed."
        },
        "instances":{
            "type":"string",
            "example":"ALL",
            "description":"Relevant for open/close pdb operations, specify one or more instance names, in a comma-separated list enclosed in parenthesis. This modifies the state of the PDB only in those instances."
        },
        "immediate":{
            "type":"boolean",
            "description":"Relevant for close pdb operations, If it is true, then this is the PDB equivalent of the SQL*Plus SHUTDOWN command with the immediate mode. Otherwise, the PDB is shut down with the normal mode"
        },
        "dryrun":{
            "type":"boolean",
            "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. No action is taken when this property is true and only the script text is returned."
        }
    }
}

Examples

Select an example This is an example request body to open a pluggable database. This is an example request body to close a pluggable database. This is an example request body to unplug and drop the database specified by the pdb_name parameter in the URL. The pluggable database will be disassociated from the container database and therefore unusable. An XML file (sales_pdb.xml in this example) will be generated with metadata about the pluggable database after it is unplugged. This metadata contains the required information to enable a CREATE PLUGGABLE DATABASE statement on a target container database to plug in the pluggable database.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of the specific Pluggable Database that is opened/closed. All data files used by the Pluggable Database are also included.

Body ()

Root Schema : DatabasePluggableDatabasesItem

Type: object

This object describes a Pluggable Database associated with the current instance. The list of attributes may vary depending on database version.

Show Source

• application_pdb: string
  Indicates whether the PDB is an application PDB.
• application_root: string
  Indicates whether the PDB is an application root.
• application_root_clone: string
  Indicates whether this PDB is an application root clone (YES) or not (NO).
• application_root_con_id: integer
  If this PDB is an application PDB, the container ID of an application root to which this application PDB belongs. If this PDB is an application root clone, the container ID of an application root to which this application root clone belongs. Otherwise, NULL.
• application_seed: string
  Indicates whether the PDB is an application seed (an application seed is also an application PDB).
• audit_files_size: integer
  Shows the current disk space usage (in bytes) by Unified Audit files (.bin format) in the current PDB.
• block_size: integer
  The current block size for the PDB.
• con_id: integer
  The ID of the container to which the data pertains.
• con_uid: integer
  Unique identifier associated with the PDB.
• create_scn: integer
  System change number (SCN) for the creation of this PDB.
• creation_time: string
  Date and time at which the PDB was created.
• dbid: integer
  PDB identifier calculated when the PDB is created and stored in all file headers associated with the PDB.
• diagnostics_size: integer
  Shows the current disk space usage (in bytes) of the diagnostic traces generated in the PDB, which is represented by the CON_ID column of the row.
• guid: string
  Globally unique identifier (GUID) of this PDB.
• guid_base64: string
  The GUID of the PDB, encoded in base64.
• inst_id: integer
  Instance number from which the associated GV$PDBS view information was obtained.
• last_changed_by: string
  Indicates what type of user last changed the PDB.
• links: array links
• local_undo: integer
  Shows whether the PDB is in local undo. This column is not relevant for CDB$ROOT.
• max_audit_size: integer
  Shows the maximum amount of disk space (in bytes) that can be used by Unified Audit files (.bin format) in the PDB.
• max_diagnostics_size: integer
  Shows the maximum amount of disk space (in bytes) that can be used by diagnostic traces generated in the PDB.
• max_size: integer
  Shows the maximum amount of disk space (in bytes) that can be used by data and temp files in the PDB.
• name: string
  Name of the PDB.
• open_mode: string
  Open mode information.
• open_time: string
  Date and time when the database was last opened.
• pdb_count: integer
  The number of user-created PDBs belonging to a given application root or CDB$ROOT. For all other containers, its value is 0.
• proxy_pdb: string
  Indicates whether this PDB is a proxy PDB (YES) or not (NO).
• recovery_status: string
  Shows whether recovery is enabled or disabled for the PDB.
• restricted: string
  Indicates whether only users possessing RESTRICTED SESSION privilege can connect to the PDB.
• snapshot_parent_con_id: string
  This column shows the container ID of the master PDB that this PDB is a snapshot clone of. This column shows a nonzero value only if the PDB is a snapshot clone. For all other cases, it shows a value of 0.
• tenant_id: string
  Pluggable database tenant key.
• total_size: integer
  Shows the disk space (in bytes) used by the PBB, including both data and temp files.
• undo_scn: integer
  System change number (SCN) at which the PDB was last converted from shared to local undo, or from local to shared undo. This column is not relevant for CDB$ROOT.
• undo_timestamp: string
  Date and time at which the PDB was last converted from shared to local undo, or from local to shared undo. This column is not relevant for CDB$ROOT.

{
    "type":"object",
    "description":"This object describes a Pluggable Database associated with the current instance. The list of attributes may vary depending on database version.",
    "properties":{
        "inst_id":{
            "type":"integer",
            "description":"Instance number from which the associated GV$PDBS view information was obtained."
        },
        "con_id":{
            "type":"integer",
            "description":"The ID of the container to which the data pertains."
        },
        "dbid":{
            "type":"integer",
            "description":"PDB identifier calculated when the PDB is created and stored in all file headers associated with the PDB."
        },
        "con_uid":{
            "type":"integer",
            "description":"Unique identifier associated with the PDB."
        },
        "guid":{
            "type":"string",
            "description":"Globally unique identifier (GUID) of this PDB."
        },
        "name":{
            "type":"string",
            "description":"Name of the PDB."
        },
        "open_mode":{
            "type":"string",
            "description":"Open mode information."
        },
        "restricted":{
            "type":"string",
            "description":"Indicates whether only users possessing RESTRICTED SESSION privilege can connect to the PDB."
        },
        "open_time":{
            "type":"string",
            "description":"Date and time when the database was last opened."
        },
        "create_scn":{
            "type":"integer",
            "description":"System change number (SCN) for the creation of this PDB."
        },
        "total_size":{
            "type":"integer",
            "description":"Shows the disk space (in bytes) used by the PBB, including both data and temp files."
        },
        "block_size":{
            "type":"integer",
            "description":"The current block size for the PDB."
        },
        "recovery_status":{
            "type":"string",
            "description":"Shows whether recovery is enabled or disabled for the PDB."
        },
        "snapshot_parent_con_id":{
            "type":"string",
            "description":"This column shows the container ID of the master PDB that this PDB is a snapshot clone of. This column shows a nonzero value only if the PDB is a snapshot clone. For all other cases, it shows a value of 0."
        },
        "application_root":{
            "type":"string",
            "description":"Indicates whether the PDB is an application root."
        },
        "application_pdb":{
            "type":"string",
            "description":"Indicates whether the PDB is an application PDB."
        },
        "application_seed":{
            "type":"string",
            "description":"Indicates whether the PDB is an application seed (an application seed is also an application PDB)."
        },
        "application_root_con_id":{
            "type":"integer",
            "description":"If this PDB is an application PDB, the container ID of an application root to which this application PDB belongs. If this PDB is an application root clone, the container ID of an application root to which this application root clone belongs. Otherwise, NULL."
        },
        "application_root_clone":{
            "type":"string",
            "description":"Indicates whether this PDB is an application root clone (YES) or not (NO)."
        },
        "proxy_pdb":{
            "type":"string",
            "description":"Indicates whether this PDB is a proxy PDB (YES) or not (NO)."
        },
        "local_undo":{
            "type":"integer",
            "description":"Shows whether the PDB is in local undo. This column is not relevant for CDB$ROOT."
        },
        "undo_scn":{
            "type":"integer",
            "description":"System change number (SCN) at which the PDB was last converted from shared to local undo, or from local to shared undo. This column is not relevant for CDB$ROOT."
        },
        "undo_timestamp":{
            "type":"string",
            "description":"Date and time at which the PDB was last converted from shared to local undo, or from local to shared undo. This column is not relevant for CDB$ROOT."
        },
        "creation_time":{
            "type":"string",
            "description":"Date and time at which the PDB was created."
        },
        "diagnostics_size":{
            "type":"integer",
            "description":"Shows the current disk space usage (in bytes) of the diagnostic traces generated in the PDB, which is represented by the CON_ID column of the row."
        },
        "pdb_count":{
            "type":"integer",
            "description":"The number of user-created PDBs belonging to a given application root or CDB$ROOT. For all other containers, its value is 0."
        },
        "audit_files_size":{
            "type":"integer",
            "description":"Shows the current disk space usage (in bytes) by Unified Audit files (.bin format) in the current PDB."
        },
        "max_size":{
            "type":"integer",
            "description":"Shows the maximum amount of disk space (in bytes) that can  be used by data and temp files in the PDB."
        },
        "max_diagnostics_size":{
            "type":"integer",
            "description":"Shows the maximum amount of disk space (in bytes) that can be used by diagnostic traces generated in the PDB."
        },
        "max_audit_size":{
            "type":"integer",
            "description":"Shows the maximum amount of disk space (in bytes) that can be used by Unified Audit files (.bin format) in the PDB."
        },
        "last_changed_by":{
            "type":"string",
            "description":"Indicates what type of user last changed the PDB."
        },
        "tenant_id":{
            "type":"string",
            "description":"Pluggable database tenant key."
        },
        "guid_base64":{
            "type":"string",
            "description":"The GUID of the PDB, encoded in base64."
        },
        "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"
    ]
}

202 Response

The response is only for unplug operations and indicates that the dbms scheduler job is created and the information on the scheduler job for unplugging a pdb.

Body ()

Root Schema : SchedulerJobsItem

Type: object

Represents a row in ALL_SCHEDULER_JOBS or DBA_SCHEDULER_JOBS views. See Oracle Database Reference documenation for more details.

Show Source

• allow_runs_in_restricted_mode: string
  Indicates whether the job is allowed to run in restricted session mode (TRUE) or not (FALSE).
• auto_drop: string
  Indicates whether the job will be dropped when it has completed (TRUE) or not (FALSE).
• client_id: string
  Client identifier of the user creating the job.
• comments: string
  Comments on the job.
• connect_credential_name: string
  Name of connect credential.
• connect_credential_owner: string
  Owner of connect credential.
• credential_name: string
  Name of the credential to be used for an external job.
• credential_owner: string
  Owner of the credential to be used for an external job.
• deferred_drop: string
  Indicates whether the job will be dropped when completed due to user request (TRUE) or not (FALSE).
• destination: string
  Destination that this job will run on.
• destination_owner: string
  Owner of the destination object (if used), else NULL.
• enabled: string
  Indicates whether the job is enabled (TRUE) or disabled (FALSE).
• end_date: string
  Date after which the job will no longer run (for an inline schedule).
• event_condition: string
  Boolean expression used as the subscription rule for the event on the source queue.
• event_queue_agent: string
  Name of the AQ agent used by the user on the event source queue (if it is a secure queue).
• event_queue_name: string
  Name of the source queue into which the event will be raised.
• event_queue_owner: string
  Owner of the source queue into which the event will be raised.
• event_rule: string
  Name of the rule used by the coordinator to trigger the event-based job.
• fail_on_script_error: string
  Indicates whether this job fails on script error (TRUE) or not (FALSE).
• failure_count: integer
  Number of times the job has failed to run.
• file_watcher_name: string
  Name of the file watcher on which this job is based.
• file_watcher_owner: string
  Owner of the file watcher on which this job is based.
• flags: integer
  This column is for internal use.
• global_uid: string
  Global user identifier of the user creating the job.
• has_constraints: string
  Indicates whether the job (not including the program of the job) is part of a resource constraint or incompatibility (TRUE) or not (FALSE).
• instance_id: integer
  Instance on which the user requests the job to run.
• instance_stickiness: string
  Indicates whether the job is sticky (TRUE) or not (FALSE).
• job_class: string
  Name of the job class associated with the job.
• job_creator: string
  Original creator of the job.
• job_name: string
  Name of the Scheduler job.
• job_priority: integer
  Priority of the job relative to other jobs in the same class.
• job_style: string
  Job style: REGULAR, LIGHTWEIGHT, IN_MEMORY_RUNTIME, IN_MEMORY_FULL.
• job_subname: string
  Subname of the Scheduler job (for a job running a chain step).
• job_type: string
  Inline job action type.
• job_weight: integer
  Weight of the job.
• last_run_duration: string
  Amount of time the job took to complete during the last run.
• last_start_date: string
  Last date on which the job started running.
• links: array links
• logging_level: string
  Amount of logging that will be done pertaining to the job.
• max_failures: integer
  Number of times the job will be allowed to fail before being marked broken.
• max_run_duration: string
  Maximum amount of time for which the job will be allowed to run.
• max_runs: integer
  Maximum number of times the job is scheduled to run.
• next_run_date: string
  Next date on which the job is scheduled to run.
• nls_env: string
  NLS environment of the job.
• number_of_destinations: integer
  Number of destinations associated with this job.
• owner: string
  Owner of the Scheduler job.
• program_name: string
  Name of the program associated with the job.
• program_owner: string
  Owner of the program associated with the job.
• raise_events: string
  List of job events to raise for the job.
• repeat_interval: string
  Inline schedule PL/SQL expression or calendar string.
• restart_on_failure: string
  Indicates whether the step should be restarted on application failure (TRUE) or not (FALSE).
• restart_on_recovery: string
  Indicates whether the step should be restarted on database recovery (TRUE) or not (FALSE).
• restartable: string
  Indicates whether the job can be restarted (TRUE) or not (FALSE).
• retry_count: integer
  Number of times the job has retried, if it is retrying.
• run_count: integer
  Number of times the job has run.
• schedule_limit: string
  Time after which a job which has not run yet will be rescheduled.
• schedule_name: string
  Name of the schedule that the job uses (can be a window or a window group)
• schedule_owner: string
  Owner of the schedule that the job uses (can be a window or a window group)
• schedule_type: string
  Type of the schedule that the job uses.
• source: string
  Source global database identifier.
• start_date: string
  Original scheduled start date of the job (for an inline schedule).
• state: string
  Current state of the job.
• stop_on_window_close: string
  Indicates whether the job will stop if a window associated with the job closes (TRUE) or not (FALSE).
• store_output: string
  Indicates whether all job output messages for the job are stored in the OUTPUT column of the *_JOB_RUN_DETAILS views for job runs that are logged.
• system: string
  Indicates whether the job is a system job (TRUE) or not (FALSE).
• uptime_failure_count: integer
  Number of failures since the database last restarted. For in-memory jobs, this column is populated, but the FAILURE_COUNT column is not populated. For all other jobs, this column is NULL.
• uptime_run_count: integer
  Number of runs since the database last restarted. For in-memory jobs, this column is populated, but the RUN_COUNT column is not populated. For all other jobs, this column is NULL.

{
    "description":"Represents a row in ALL_SCHEDULER_JOBS or DBA_SCHEDULER_JOBS views. See Oracle Database Reference documenation for more details.",
    "type":"object",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the Scheduler job."
        },
        "job_name":{
            "type":"string",
            "description":"Name of the Scheduler job."
        },
        "job_subname":{
            "type":"string",
            "description":"Subname of the Scheduler job (for a job running a chain step)."
        },
        "job_style":{
            "type":"string",
            "description":"Job style: REGULAR, LIGHTWEIGHT, IN_MEMORY_RUNTIME, IN_MEMORY_FULL."
        },
        "job_creator":{
            "type":"string",
            "description":"Original creator of the job."
        },
        "client_id":{
            "type":"string",
            "description":"Client identifier of the user creating the job."
        },
        "global_uid":{
            "type":"string",
            "description":"Global user identifier of the user creating the job."
        },
        "program_owner":{
            "type":"string",
            "description":"Owner of the program associated with the job."
        },
        "program_name":{
            "type":"string",
            "description":"Name of the program associated with the job."
        },
        "job_type":{
            "type":"string",
            "description":"Inline job action type."
        },
        "schedule_owner":{
            "type":"string",
            "description":"Owner of the schedule that the job uses (can be a window or a window group)"
        },
        "schedule_name":{
            "type":"string",
            "description":"Name of the schedule that the job uses (can be a window or a window group)"
        },
        "schedule_type":{
            "type":"string",
            "description":"Type of the schedule that the job uses."
        },
        "start_date":{
            "type":"string",
            "description":"Original scheduled start date of the job (for an inline schedule)."
        },
        "repeat_interval":{
            "type":"string",
            "description":"Inline schedule PL/SQL expression or calendar string."
        },
        "event_queue_owner":{
            "type":"string",
            "description":"Owner of the source queue into which the event will be raised."
        },
        "event_queue_name":{
            "type":"string",
            "description":"Name of the source queue into which the event will be raised."
        },
        "event_queue_agent":{
            "type":"string",
            "description":"Name of the AQ agent used by the user on the event source queue (if it is a secure queue)."
        },
        "event_condition":{
            "type":"string",
            "description":"Boolean expression used as the subscription rule for the event on the source queue."
        },
        "event_rule":{
            "type":"string",
            "description":"Name of the rule used by the coordinator to trigger the event-based job."
        },
        "file_watcher_owner":{
            "type":"string",
            "description":"Owner of the file watcher on which this job is based."
        },
        "file_watcher_name":{
            "type":"string",
            "description":"Name of the file watcher on which this job is based."
        },
        "end_date":{
            "type":"string",
            "description":"Date after which the job will no longer run (for an inline schedule)."
        },
        "job_class":{
            "type":"string",
            "description":"Name of the job class associated with the job."
        },
        "enabled":{
            "type":"string",
            "description":"Indicates whether the job is enabled (TRUE) or disabled (FALSE)."
        },
        "auto_drop":{
            "type":"string",
            "description":"Indicates whether the job will be dropped when it has completed (TRUE) or not (FALSE)."
        },
        "restart_on_recovery":{
            "type":"string",
            "description":"Indicates whether the step should be restarted on database recovery (TRUE) or not (FALSE)."
        },
        "restart_on_failure":{
            "type":"string",
            "description":"Indicates whether the step should be restarted on application failure (TRUE) or not (FALSE)."
        },
        "state":{
            "type":"string",
            "description":"Current state of the job."
        },
        "job_priority":{
            "type":"integer",
            "description":"Priority of the job relative to other jobs in the same class."
        },
        "run_count":{
            "type":"integer",
            "description":"Number of times the job has run."
        },
        "uptime_run_count":{
            "type":"integer",
            "description":"Number of runs since the database last restarted. For in-memory jobs, this column is populated, but the RUN_COUNT column is not populated. For all other jobs, this column is NULL."
        },
        "max_runs":{
            "type":"integer",
            "description":"Maximum number of times the job is scheduled to run."
        },
        "failure_count":{
            "type":"integer",
            "description":"Number of times the job has failed to run."
        },
        "uptime_failure_count":{
            "type":"integer",
            "description":"Number of failures since the database last restarted. For in-memory jobs, this column is populated, but the FAILURE_COUNT column is not populated. For all other jobs, this column is NULL."
        },
        "max_failures":{
            "type":"integer",
            "description":"Number of times the job will be allowed to fail before being marked broken."
        },
        "retry_count":{
            "type":"integer",
            "description":"Number of times the job has retried, if it is retrying."
        },
        "last_start_date":{
            "type":"string",
            "description":"Last date on which the job started running."
        },
        "last_run_duration":{
            "type":"string",
            "description":"Amount of time the job took to complete during the last run."
        },
        "next_run_date":{
            "type":"string",
            "description":"Next date on which the job is scheduled to run."
        },
        "schedule_limit":{
            "type":"string",
            "description":"Time after which a job which has not run yet will be rescheduled."
        },
        "max_run_duration":{
            "type":"string",
            "description":"Maximum amount of time for which the job will be allowed to run."
        },
        "logging_level":{
            "type":"string",
            "description":"Amount of logging that will be done pertaining to the job."
        },
        "store_output":{
            "type":"string",
            "description":"Indicates whether all job output messages for the job are stored in the OUTPUT column of the *_JOB_RUN_DETAILS views for job runs that are logged."
        },
        "stop_on_window_close":{
            "type":"string",
            "description":"Indicates whether the job will stop if a window associated with the job closes (TRUE) or not (FALSE)."
        },
        "instance_stickiness":{
            "type":"string",
            "description":"Indicates whether the job is sticky (TRUE) or not (FALSE)."
        },
        "raise_events":{
            "type":"string",
            "description":"List of job events to raise for the job."
        },
        "system":{
            "type":"string",
            "description":"Indicates whether the job is a system job (TRUE) or not (FALSE)."
        },
        "job_weight":{
            "type":"integer",
            "description":"Weight of the job."
        },
        "nls_env":{
            "type":"string",
            "description":"NLS environment of the job."
        },
        "source":{
            "type":"string",
            "description":"Source global database identifier."
        },
        "number_of_destinations":{
            "type":"integer",
            "description":"Number of destinations associated with this job."
        },
        "destination_owner":{
            "type":"string",
            "description":"Owner of the destination object (if used), else NULL."
        },
        "destination":{
            "type":"string",
            "description":"Destination that this job will run on."
        },
        "credential_owner":{
            "type":"string",
            "description":"Owner of the credential to be used for an external job."
        },
        "credential_name":{
            "type":"string",
            "description":"Name of the credential to be used for an external job."
        },
        "instance_id":{
            "type":"integer",
            "description":"Instance on which the user requests the job to run."
        },
        "deferred_drop":{
            "type":"string",
            "description":"Indicates whether the job will be dropped when completed due to user request (TRUE) or not (FALSE)."
        },
        "allow_runs_in_restricted_mode":{
            "type":"string",
            "description":"Indicates whether the job is allowed to run in restricted session mode (TRUE) or not (FALSE)."
        },
        "comments":{
            "type":"string",
            "description":"Comments on the job."
        },
        "flags":{
            "type":"integer",
            "description":"This column is for internal use."
        },
        "restartable":{
            "type":"string",
            "description":"Indicates whether the job can be restarted (TRUE) or not (FALSE)."
        },
        "has_constraints":{
            "type":"string",
            "description":"Indicates whether the job (not including the program of the job) is part of a resource constraint or incompatibility (TRUE) or not (FALSE)."
        },
        "connect_credential_owner":{
            "type":"string",
            "description":"Owner of connect credential."
        },
        "connect_credential_name":{
            "type":"string",
            "description":"Name of connect credential."
        },
        "fail_on_script_error":{
            "type":"string",
            "description":"Indicates whether this job fails on script error (TRUE) or not (FALSE)."
        },
        "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"
    ]
}

404 Response

Bad request, it could be the pdb name in URL does not exist

Back to Top