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
Nested Schema : bulkExtracts-columns
Type: object
The list item that describes an object property to extract.
Show Source
Nested Schema : bulkExtracts-filters
Type: object
The list item that describes a criterion for filtering the extract results.
Show Source
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
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
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
Back to Top

Response

Default Response

Body ()
Root Schema : bulkExtracts
Type: object
The parameters of the bulk extract job.
Show Source
Nested Schema : bulkExtracts-columns
Type: object
The list item that describes an object property to extract.
Show Source
Nested Schema : bulkExtracts-filters
Type: object
The list item that describes a criterion for filtering the extract results.
Show Source
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
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
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
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