Get a bulk extract
get
/services/rest/connect/v1.4/bulkExtracts/{id}
Request
Path Parameters
-
id: integer
The unique identifier of the bulk extract job.
Response
Default Response
Root Schema : bulkExtracts
Type:
object
The parameters of the bulk extract job.
Show Source
-
class(optional):
string
Maximum Length:
256
Pattern:^Incident$
The object type to be extracted. -
columns(optional):
object bulkExtracts-columns
The list item that describes an object property to extract.
-
createdByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the bulk extract job was created. This attribute is read-only.
-
filters(optional):
object bulkExtracts-filters
The list item that describes a criterion for filtering the extract results.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the bulk extract job. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the bulk extract job. -
name(optional):
string
Maximum Length:
80
Pattern:^[^ ]*$
The name used to describe the bulk extract job. -
state(optional):
object namedIDs-bulkExtracts-state
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
type(optional):
object namedIDs-bulkExtracts-type
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
updatedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime(optional):
string
The date and time when the bulk extract job was last updated. This attribute is read-only.
-
version(optional):
string
Maximum Length:
80
The version of the object data being extracted. It is represented in the string format as v1.x, where x is greater than or equal to 4. For example, v1.4.
Nested Schema : bulkExtracts-columns
Type:
object
The list item that describes an object property to extract.
Show Source
-
displayOrder(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The order in which specified columns should appear in the SQL select clause. -
name(optional):
string
Maximum Length:
349525
The property name of the list item.
Nested Schema : bulkExtracts-filters
Type:
object
The list item that describes a criterion for filtering the extract results.
Show Source
-
filterOperator(optional):
object namedIDs-bulkExtracts-filters-filterOperator
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the ROQL filter. -
leftOperand(optional):
string
Maximum Length:
349525
The left operand of the filter expression. -
rightOperand(optional):
string
Maximum Length:
349525
The right operand of the filter expression.
Nested Schema : namedIDs-bulkExtracts-state
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-bulkExtracts-type
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-bulkExtracts-filters-filterOperator
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Examples
Use GET with the following syntax to retrieve data for a bulkExtract object:
https://your_site_interface/services/rest/connect/version/bulkExtracts/bulkExtract_id
Request URI example:
https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2
Response example
{ "id": 2, "lookupName": "ExtractExample", "createdTime": "2019-01-14T17:52:47.000Z", "updatedTime": "2019-01-14T17:52:47.000Z", "class": "Incident", "columns": { "links": [ { "rel": "self", "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2/columns" }, { "rel": "full", "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2/columns/{column_id}", "templated": true } ] }, "createdByAccount": { "links": [ { "rel": "self", "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2" }, { "rel": "canonical", "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2" }, { "rel": "describedby", "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts", "mediaType": "application/schema+json" } ] }, "filters": { "links": [ { "rel": "self", "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2/filters" }, { "rel": "full", "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2/filters/{filter_id}", "templated": true } ] }, "name": "ExtractExample", "state": { "id": 1, "lookupName": "Run" }, "type": { "id": 1, "lookupName": "Single" }, "updatedByAccount": { "links": [ { "rel": "self", "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2" }, { "rel": "canonical", "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/2" }, { "rel": "describedby", "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts", "mediaType": "application/schema+json" } ] }, "version": "v1.4", "links": [ { "rel": "self", "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2" }, { "rel": "canonical", "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/2" }, { "rel": "describedby", "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/bulkExtracts", "mediaType": "application/schema+json" } ] }