Jump to

• Request
• Response
• Examples

Get a bulk extract result

get

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

Request

Path Parameters

• id: integer
  The unique identifier of the bulk extract result.

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(optional): object 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.
• 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 result was created. This attribute is read-only.
• description(optional): [ "string", "null" ]
  Maximum Length: 1333

  The description of the bulk extract result.
• exportedData(optional): object bulkExtractResults-exportedData
  The file attachments associated with the results of a bulk extract request.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the bulk extract result.
• intervalRowCount(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The number of rows processed for this interval event.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the bulk extract result.
• processGuard(optional): [ "integer", "null" ]
  Minimum Value: -2147483645

  Maximum Value: 2147483647

  The number which ensures that only a single bulk extract job runs at a time.
• state(optional): object 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.
• totalRowCount(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The cumulative, running count of the number of object rows extracted during runtime.
• 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 result was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The results of bulk extracts containing information about the object records retrieved from Oracle B2C Service.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the bulk extract result was last updated. This attribute is read-only."
        },
        "description":{
            "type":[
                "string",
                "null"
            ],
            "description":"The description of the bulk extract result.",
            "maxLength":1333
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "intervalRowCount":{
            "minimum":0,
            "type":"integer",
            "description":"The number of rows processed for this interval event.",
            "maximum":2147483647
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the bulk extract result.",
            "maxLength":255
        },
        "state":{
            "type":"object",
            "description":"The latest status of a bulk extract job.",
            "$ref":"#/definitions/namedIDs-bulkExtractResults-state"
        },
        "bulkExtract":{
            "type":"object",
            "description":"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."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the bulk extract result was created. This attribute is read-only."
        },
        "exportedData":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The resulting data from the execution of the extract.",
            "$ref":"#/definitions/bulkExtractResults-exportedData"
        },
        "totalRowCount":{
            "minimum":0,
            "type":"integer",
            "description":"The cumulative, running count of the number of object rows extracted during runtime.",
            "maximum":2147483647
        },
        "createdByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the bulk extract result.",
            "maximum":9.223372036854776E18
        },
        "processGuard":{
            "minimum":-2147483645,
            "type":[
                "integer",
                "null"
            ],
            "description":"The number which ensures that only a single bulk extract job runs at a time.",
            "maximum":2147483647
        }
    }
}

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

• contentType(optional): string
  Maximum Length: 128

  Pattern: ^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$

  The MIME content type of the file.
• createdTime(optional): string
  The date and time when the file was associated with the object.
• data(optional): string
  The data contained in the file.
• description(optional): string
  Maximum Length: 1333

  The description for the contents of the file attachment.
• fileName(optional): string
  Maximum Length: 100

  Pattern: ^[^ \/:*?"<>|]*$

  The name of the file when saving it to the disk.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the attachment. This is the key for the list entry.
• name(optional): string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The short display name of the file attachment.
• private(optional): boolean
  Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
• size(optional): integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The size of the file in bytes.
• updatedTime(optional): [ "string", "null" ]
  The date and time when the file was last updated. This attribute is read-only.
• uRL(optional): string
  Maximum Length: 1333

  The URL to access this file.

{
    "type":"object",
    "description":"The file attachments associated with the results of a bulk extract request.",
    "properties":{
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the file was last updated. This attribute is read-only."
        },
        "contentType":{
            "pattern":"^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$",
            "type":"string",
            "description":"The MIME content type of the file.",
            "maxLength":128
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The short display name of the file attachment.",
            "maxLength":40
        },
        "uRL":{
            "type":"string",
            "description":"The URL to access this file.",
            "maxLength":1333
        },
        "description":{
            "type":"string",
            "description":"The description for the contents of the file attachment.",
            "maxLength":1333
        },
        "private":{
            "type":"boolean",
            "description":"Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value."
        },
        "fileName":{
            "pattern":"^[^\t\n\\/:*?\"<>|]*$",
            "type":"string",
            "description":"The name of the file when saving it to the disk.",
            "maxLength":100
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the file was associated with the object."
        },
        "data":{
            "type":"string",
            "description":"The data contained in the file."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the attachment. This is the key for the list entry.",
            "maximum":9.223372036854776E18
        },
        "size":{
            "minimum":1,
            "type":"integer",
            "description":"The size of the file in bytes.",
            "maximum":2147483647
        }
    }
}

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

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

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