Jump to

• Request
• Response
• Examples

Get multiple bulk extract results

get

/services/rest/connect/v1.4/bulkExtractResults

Request

Supported Media Types

• application/x-www-form-urlencoded

Query Parameters

• fields: string
  The list of attributes that should be returned in the response. The syntax contains a comma delimited string of attributes.
  For example: ?fields=attribute1,attribute2
• limit: integer
  The requested page size, which limits the number of records returned in the response.
  For example: ?limit=100
• offset: integer
  The starting position of the record. For example, if you set an offset of 8, the request will skip the first eight records, and include the records from the ninth record in the response. The default value is 0, which means that the records will be returned from the first record.
  For example: ?offset=8
• orderBy: string
  The list of attributes used to determine the order in which the records are returned. The syntax contains a comma delimited string of attributes, with each attribute optionally followed by 'asc' or 'desc'. Specify 'asc' for ascending order and 'desc' for descending order. The default value is 'asc'.
  For example: ?orderBy=field1:asc,field2:desc
• q: string
  The query parameter that allows searching by providing ROQL 'where' clause filtering.
  For example: ?q=id>2 and id<10< div>
• totalResults: boolean
  Indicates whether the count for the total number of records returned should be shown. The default value is false.
  If you set the value of totalResults as true, the response will include the count of records retrieved by the request.
  Example response:"totalResults": 27

Back to Top

Response

Supported Media Types

• application/json;type=collection

Default Response

Body ()

Root Schema : bulkExtractResults-collection

Type: object

Collection of bulkExtractResults

Show Source

• createdTime(optional): string
  The date and time when the bulk extract result was created. This attribute is read-only.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the bulk extract result.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the bulk extract result.
• updatedTime(optional): string
  The date and time when the bulk extract result was last updated. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "createdTime":{
            "$ref":"#/definitions/bulkExtractResults/properties/createdTime"
        },
        "updatedTime":{
            "$ref":"#/definitions/bulkExtractResults/properties/updatedTime"
        },
        "id":{
            "$ref":"#/definitions/bulkExtractResults/properties/id"
        },
        "lookupName":{
            "$ref":"#/definitions/bulkExtractResults/properties/lookupName"
        }
    },
    "description":"Collection of bulkExtractResults"
}

Back to Top

Examples

Use GET with the following syntax to list all bulkExtractResults:

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

Request URI example:

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

Response body example

{
    "items": [
        {
            "id": 2,
            "lookupName": "2",
            "createdTime": "2019-01-14T17:52:48.000Z",
            "updatedTime": "2019-01-14T17:52:49.000Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/2"
                }
            ]
        },
        {
            "id": 3,
            "lookupName": "3",
            "createdTime": "2019-01-14T17:52:49.000Z",
            "updatedTime": "2019-01-14T17:52:50.000Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/3"
                }
            ]
        },
        {
            "id": 4,
            "lookupName": "4",
            "createdTime": "2019-01-14T17:52:50.000Z",
            "updatedTime": "2019-01-14T17:52:52.000Z",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults/4"
                }
            ]
        }
    ],
    "hasMore": false,
    "links": [
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/bulkExtractResults",
            "mediaType": "application/schema+json"
        },
        {
            "rel": "search-form",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults-search-form"
        },
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/bulkExtractResults"
        }
    ]
}

Back to Top