Bulk index groups

Replaces the groups in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints.

SecurityBearerAuth
Request
Request Body schema: application/json
required
uploadId
required
string

Unique id that must be used for this instance of datasource groups upload

isFirstPage
boolean

true if this is the first page of the upload. Defaults to false

isLastPage
boolean

true if this is the last page of the upload. Defaults to false

forceRestartUpload
boolean

Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true

datasource
required
string

datasource of the groups

required
Array of objects (DatasourceGroupDefinition)

batch of groups for the datasource

disableStaleDataDeletionCheck
boolean

True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when isLastPage = true

Responses
200

OK

400

Bad Request

401

Not Authorized

409

Conflict

post/bulkindexgroups
Request samples
application/json
{
  • "uploadId": "string",
  • "isFirstPage": true,
  • "isLastPage": true,
  • "forceRestartUpload": true,
  • "datasource": "string",
  • "groups": [
    • {
      • "name": "string"
      }
    ],
  • "disableStaleDataDeletionCheck": true
}