Bulk Cluster Options by lookupKey

POST 
/clusters/:lookupKey/:lookupValue/options/bulk

The bulk endpoints offer an efficient way of importing/updating large amounts of cluster options with just a single API call. The same lookup key is used for the options as for the cluster. When using the bulk id endpoint, the options are identified by Propeller option id. If an option with such id doesn't already exist, it will be created. If it does exist, the option will be updated.

Fields

Name	Required
names	no
descriptions	no
shortDescriptions	no
language	no
sourceId	no
source	only when sourceId is provided
isRequired	no

Directives

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing option that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing option in the parent cluster provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for an option that are not provided in the payload	empty array
skipCreate	Do not create new options, only update existing	empty array

What are directives?

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about cluster lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

application/json

Body

directives

object[]

Array [

fields string[]

operation string

]

options

object[]

Array [

descriptions

object[]

Array [

language string

value string

]

isRequired boolean

language string

names

object[]

Array [

language string

value string

]

shortDescriptions

object[]

Array [

language string

value string

]

source string

sourceId string

]

Responses

200

Bulk Cluster Options by lookupKey - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object[]

Array [

action string

id number

key string

lookupKey string

success boolean

]

messages string[]
total number

Example (from schema)

{
  "data": [
    {
      "action": "update",
      "id": 214,
      "key": "K72334000",
      "lookupKey": "sourceId",
      "success": true
    },
    {
      "action": "create",
      "id": 216,
      "key": "KM636000",
      "lookupKey": "sourceId",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 2
}

Bulk Cluster Options by lookupKey - 200

{
  "data": [
    {
      "action": "update",
      "id": 214,
      "key": "K72334000",
      "lookupKey": "sourceId",
      "success": true
    },
    {
      "action": "create",
      "id": 216,
      "key": "KM636000",
      "lookupKey": "sourceId",
      "success": true
    }
  ],
  "messages": [
    "Completed"
  ],
  "total": 2
}

404

Bulk Cluster Options by lookupKey - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent Cluster with sourceId [COFYR8800] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Bulk Cluster Options by lookupKey - 404

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent Cluster with sourceId [COFYR8800] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentClusterNotFound"
  }
}

Loading...