Bulk Clusters by Id

POST 
/clusters/bulk/id

The bulk endpoints offer an efficient way of importing/updating large amounts of categories with just a single API call. When using the bulk id endpoint, the categories are identified by Propeller category id. If a category with such id doesn't already exist, it will be created. If it does exist, the category will be updated.

Category Bulk endpoints support bulk change of category attributes for multiple categories as well. To learn more about Attributes, go here.

A single category's attributes can be modified as explained in Bulk resource attribute values by resource lookup key, but if it's needed to modify attributes for multiple categories, this endpoint should be used.

Fields

Name	Required
categories (array of category objects)	yes
sourceId	yes
source	yes
language	yes
names	yes
descriptions	no
shortDescriptions	no
attributes Read more about attributes	no
parent	yes

For more details on attributes field, read this.

Directives

Name	Description	Fields
skipIfNotEmpty	On update, skip updating fields of an existing category that are not empty	array of field names e.g. names, descriptions, etc.
skipMoveOnUpdate	On update, skip moving an existing category in the parent category provided	empty array
mergeTranslationsOnUpdate	On update, delete all translation for a category that are not provided in the payload	empty array

What are directives?

Request

application/json

Body

clusters

object[]

Array [

clusterConfigId number

code string

descriptions

object[]

Array [

language string

value string

]

id number

names

object[]

Array [

language string

value string

]

parent

object

id number

]

directives

object[]

Array [

fields string[]

operation string

]

Responses

200

Loading...