REST APIs for Oracle Database

Get all data pump jobs

get

/database/datapump/jobs/

Describes all Data Pump jobs in the database. Uses DBA_DATAPUMP_JOBS view. A client requires SQL Administrator role to invoke this service.

Request

Supported Media Types

application/json

Query Parameters

limit(optional): integer(int32)

The maximum number of records to return.
q(optional): string

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.

Response

Supported Media Types

application/json

200 Response

All Data Pump jobs in the database.

Root Schema : DataPumpJobs

Type: object

DBA_DATAPUMP_JOBS identifies all active Data Pump jobs in the database, regardless of their state, on an instance (or on all instances for Real Application Clusters). It also show all Data Pump master tables not currently associated with an active job.

Show Source

count(optional): integer

Total number of records in the current response.
hasMore(optional): boolean

Indicates if there are more records to be retrieved.
items(optional): array items
limit(optional): integer

The actual page size limit on number of records applied by the server.
links(optional): array links
offset(optional): integer

The actual index from which the item resources are returned.

{
    "type":"object",
    "description":"DBA_DATAPUMP_JOBS identifies all active Data Pump jobs in the database, regardless of their state, on an instance (or on all instances for Real Application Clusters). It also show all Data Pump master tables not currently associated with an active job.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataPumpJobsItem"
            }
        },
        "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":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object DataPumpJobsItem

This object represents a specified Data Pump job in the database.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataPumpJobsItem"
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object LinkRelation

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

Nested Schema : DataPumpJobsItem

Type: object

This object represents a specified Data Pump job in the database.

Show Source

attached_sessions(optional): integer

Number of sessions attached to the job.
datapump_sessions(optional): integer

Number of Data Pump sessions participating in the job.
degree(optional): integer

Number of worker processes performing the operation.
job_mode(optional): string

Mode of job.
job_name(optional): string

User-supplied name for the job (or the default name generated by the server).
links(optional): array links
operation(optional): string

Type of job.
owner_name(optional): string

User that initiated the job.
state(optional): string

Current job state.

{
    "type":"object",
    "description":"This object represents a specified Data Pump job in the database.",
    "properties":{
        "owner_name":{
            "type":"string",
            "description":"User that initiated the job."
        },
        "job_name":{
            "type":"string",
            "description":"User-supplied name for the job (or the default name generated by the server)."
        },
        "operation":{
            "type":"string",
            "description":"Type of job."
        },
        "job_mode":{
            "type":"string",
            "description":"Mode of job."
        },
        "state":{
            "type":"string",
            "description":"Current job state."
        },
        "degree":{
            "type":"integer",
            "description":"Number of worker processes performing the operation."
        },
        "attached_sessions":{
            "type":"integer",
            "description":"Number of sessions attached to the job."
        },
        "datapump_sessions":{
            "type":"integer",
            "description":"Number of Data Pump sessions participating in the job."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

href: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}