1. REST API for Oracle B2C Service
  2. Tasks
  3. Bulk Extract Results

Get a bulk extract result

get

/services/rest/connect/v1.4/bulkExtractResults/{id}

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : bulkExtractResults
Type: object
The results of bulk extracts containing information about the object records retrieved from Oracle B2C Service.
Show Source
  • bulkExtract
    The parameters of the bulk extract job. It is the reference to a resource in 'bulkExtracts' collection. Only ID or lookupName can be provided to specify the resource.
  • 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.
  • The date and time when the bulk extract result was created. This attribute is read-only.
  • Maximum Length: 1333
    The description of the bulk extract result.
  • bulkExtractResults-exportedData
    The file attachments associated with the results of a bulk extract request.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the bulk extract result.
  • Minimum Value: 0
    Maximum Value: 2147483647
    The number of rows processed for this interval event.
  • Maximum Length: 255
    The name used to look up the bulk extract result.
  • Minimum Value: -2147483645
    Maximum Value: 2147483647
    The number which ensures that only a single bulk extract job runs at a time.
  • namedIDs-bulkExtractResults-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.
  • Minimum Value: 0
    Maximum Value: 2147483647
    The cumulative, running count of the number of object rows extracted during runtime.
  • 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.
  • The date and time when the bulk extract result was last updated. This attribute is read-only.
Nested Schema : bulkExtract
Type: object
The parameters of the bulk extract job. It is the reference to a resource in 'bulkExtracts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : bulkExtractResults-exportedData
Type: object
The file attachments associated with the results of a bulk extract request.
Show Source
  • Maximum Length: 128
    Pattern: ^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$
    The MIME content type of the file.
  • The date and time when the file was associated with the object.
  • The data contained in the file.
  • Maximum Length: 1333
    The description for the contents of the file attachment.
  • Maximum Length: 100
    Pattern: ^[^ \/:*?"<>|]*$
    The name of the file when saving it to the disk.
  • Minimum Value: 1
    Maximum Value: 9223372036854776000
    The unique identifier of the attachment. This is the key for the list entry.
  • Maximum Length: 40
    Pattern: ^[^ ]*$
    The short display name of the file attachment.
  • Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
  • Minimum Value: 1
    Maximum Value: 2147483647
    The size of the file in bytes.
  • The date and time when the file was last updated. This attribute is read-only.
  • Maximum Length: 1333
    The URL to access this file.
Nested Schema : namedIDs-bulkExtractResults-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
Back to Top

Examples

Use GET with the following syntax to retrieve data for a bulkExtractResult object:

https://your_site_interface/services/rest/connect/version/bulkExtractResults/bulkExtractResult_id

Request URI example:

https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/2

Response example

{
    "id": 2,
    "lookupName": "2",
    "createdTime": "2019-01-14T17:52:48.000Z",
    "updatedTime": "2019-01-14T17:52:49.000Z",
    "bulkExtract": {
        "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"
            }
        ]
    },
    "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"
            }
        ]
    },
    "description": "Completed Successfully",
    "exportedData": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/2/exportedData"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/2/exportedData/{exportedData_id}",
                "templated": true
            }
        ]
    },
    "intervalRowCount": 73,
    "processGuard": 1547509828,
    "state": {
        "id": 3,
        "lookupName": "Completed"
    },
    "totalRowCount": 73,
    "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"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/2"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/2"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/bulkExtractResults",
            "mediaType": "application/schema+json"
        }
    ]
}
Back to Top