Jump to

• Request
• Response
• Examples

Create a bulk extract

post

/services/rest/connect/v1.4/bulkExtracts

Request

Body ()

The parameters of the bulk extract job.

Root Schema : bulkExtracts

Type: object

The parameters of the bulk extract job.

Show Source

• class: string
  Maximum Length: 256

  Pattern: ^Incident$

  The object type to be extracted.
• columns: object bulkExtracts-columns
  The list item that describes an object property to extract.
• createdByAccount: [ "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: string
  The date and time when the bulk extract job was created. This attribute is read-only.
• filters: object bulkExtracts-filters
  The list item that describes a criterion for filtering the extract results.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the bulk extract job.
• lookupName: string
  Maximum Length: 255

  The name used to look up the bulk extract job.
• name: string
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name used to describe the bulk extract job.
• state: 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: 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: [ "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: string
  The date and time when the bulk extract job was last updated. This attribute is read-only.
• version: 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.

{
    "type":"object",
    "description":"The parameters of the bulk extract job.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the bulk extract job was last updated. This attribute is read-only."
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The name used to describe the bulk extract job.",
            "maxLength":"80"
        },
        "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."
        },
        "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."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the bulk extract job.",
            "maxLength":"255"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the bulk extract job.",
            "maximum":"9223372036854776000"
        },
        "state":{
            "type":"object",
            "description":"The user command to change the disposition of the extract job.",
            "$ref":"#/definitions/namedIDs-bulkExtracts-state"
        },
        "version":{
            "type":"string",
            "description":"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.",
            "maxLength":"80"
        },
        "filters":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The filter criteria to pass for an extracted row.",
            "$ref":"#/definitions/bulkExtracts-filters"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the bulk extract job was created. This attribute is read-only."
        },
        "type":{
            "type":"object",
            "description":"The type of extract to perform.",
            "$ref":"#/definitions/namedIDs-bulkExtracts-type"
        },
        "class":{
            "pattern":"^Incident$",
            "type":"string",
            "description":"The object type to be extracted.",
            "maxLength":"256"
        },
        "columns":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The properties of the class to be included in the extract.",
            "$ref":"#/definitions/bulkExtracts-columns"
        }
    }
}

Nested Schema : bulkExtracts-columns

Type: object

The list item that describes an object property to extract.

Show Source

• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The order in which specified columns should appear in the SQL select clause.
• name: string
  Maximum Length: 349525

  The property name of the list item.

{
    "type":"object",
    "description":"The list item that describes an object property to extract.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The property name of the list item.",
            "maxLength":"349525"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The order in which specified columns should appear in the SQL select clause.",
            "maximum":"2147483647"
        }
    }
}

Nested Schema : bulkExtracts-filters

Type: object

The list item that describes a criterion for filtering the extract results.

Show Source

• filterOperator: 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: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the ROQL filter.
• leftOperand: string
  Maximum Length: 349525

  The left operand of the filter expression.
• rightOperand: string
  Maximum Length: 349525

  The right operand of the filter expression.

{
    "type":"object",
    "description":"The list item that describes a criterion for filtering the extract results.",
    "properties":{
        "filterOperator":{
            "type":"object",
            "description":"The logical operator for the filter expression.",
            "$ref":"#/definitions/namedIDs-bulkExtracts-filters-filterOperator"
        },
        "rightOperand":{
            "type":"string",
            "description":"The right operand of the filter expression.",
            "maxLength":"349525"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the ROQL filter.",
            "maximum":"9223372036854776000"
        },
        "leftOperand":{
            "type":"string",
            "description":"The left operand of the filter expression.",
            "maxLength":"349525"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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

Response

Default Response

Body ()

Root Schema : bulkExtracts

Type: object

The parameters of the bulk extract job.

Show Source

• class: string
  Maximum Length: 256

  Pattern: ^Incident$

  The object type to be extracted.
• columns: object bulkExtracts-columns
  The list item that describes an object property to extract.
• createdByAccount: [ "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: string
  The date and time when the bulk extract job was created. This attribute is read-only.
• filters: object bulkExtracts-filters
  The list item that describes a criterion for filtering the extract results.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the bulk extract job.
• lookupName: string
  Maximum Length: 255

  The name used to look up the bulk extract job.
• name: string
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name used to describe the bulk extract job.
• state: 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: 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: [ "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: string
  The date and time when the bulk extract job was last updated. This attribute is read-only.
• version: 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.

{
    "type":"object",
    "description":"The parameters of the bulk extract job.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the bulk extract job was last updated. This attribute is read-only."
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The name used to describe the bulk extract job.",
            "maxLength":"80"
        },
        "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."
        },
        "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."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the bulk extract job.",
            "maxLength":"255"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the bulk extract job.",
            "maximum":"9223372036854776000"
        },
        "state":{
            "type":"object",
            "description":"The user command to change the disposition of the extract job.",
            "$ref":"#/definitions/namedIDs-bulkExtracts-state"
        },
        "version":{
            "type":"string",
            "description":"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.",
            "maxLength":"80"
        },
        "filters":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The filter criteria to pass for an extracted row.",
            "$ref":"#/definitions/bulkExtracts-filters"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the bulk extract job was created. This attribute is read-only."
        },
        "type":{
            "type":"object",
            "description":"The type of extract to perform.",
            "$ref":"#/definitions/namedIDs-bulkExtracts-type"
        },
        "class":{
            "pattern":"^Incident$",
            "type":"string",
            "description":"The object type to be extracted.",
            "maxLength":"256"
        },
        "columns":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The properties of the class to be included in the extract.",
            "$ref":"#/definitions/bulkExtracts-columns"
        }
    }
}

Nested Schema : bulkExtracts-columns

Type: object

The list item that describes an object property to extract.

Show Source

• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The order in which specified columns should appear in the SQL select clause.
• name: string
  Maximum Length: 349525

  The property name of the list item.

{
    "type":"object",
    "description":"The list item that describes an object property to extract.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The property name of the list item.",
            "maxLength":"349525"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The order in which specified columns should appear in the SQL select clause.",
            "maximum":"2147483647"
        }
    }
}

Nested Schema : bulkExtracts-filters

Type: object

The list item that describes a criterion for filtering the extract results.

Show Source

• filterOperator: 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: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the ROQL filter.
• leftOperand: string
  Maximum Length: 349525

  The left operand of the filter expression.
• rightOperand: string
  Maximum Length: 349525

  The right operand of the filter expression.

{
    "type":"object",
    "description":"The list item that describes a criterion for filtering the extract results.",
    "properties":{
        "filterOperator":{
            "type":"object",
            "description":"The logical operator for the filter expression.",
            "$ref":"#/definitions/namedIDs-bulkExtracts-filters-filterOperator"
        },
        "rightOperand":{
            "type":"string",
            "description":"The right operand of the filter expression.",
            "maxLength":"349525"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the ROQL filter.",
            "maximum":"9223372036854776000"
        },
        "leftOperand":{
            "type":"string",
            "description":"The left operand of the filter expression.",
            "maxLength":"349525"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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 POST with the following syntax to create a new bulkExtract object:

https://your_site_interface/services/rest/connect/version/bulkExtracts

Request URI example:

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

Request body example

{
 "class": "Incident",
 "name": "ExtractExample",
 "state": {
   "lookupName":"Run"
   },
 "version": "v1.4",
 "filters": [
  {
      "leftOperand": "CreatedTime",
      "filterOperator": {
          "lookupName": ">"
        },
      "rightOperand": "'2018-05-01T00:00:00.000Z'"
  }
    ]
}

Response body example

{
    "id": 1,
    "lookupName": "ExtractExample",
    "createdTime": "2019-01-14T17:27:31.000Z",
    "updatedTime": "2019-01-14T17:27:31.000Z",
    "class": "Incident",
    "columns": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/1/columns"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/1/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/1/filters"
            },
            {
                "rel": "full",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/1/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/1"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtracts/1"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/bulkExtracts",
            "mediaType": "application/schema+json"
        }
    ]
}

Back to Top