REST API for Oracle Commerce Cloud December 2017

Partial update an index attribute

patch

/gsadmin/v1/{appName}/attributes/{owner}/{attributeName}

Partial updates the specific index attribute in the given config owner attributes list.

Supported Media Types

Path Parameters

appName: Type: string

Required: true

Specifies the name of your application, for example, Discover.
attributeName: Type: string

Required: true

Specifies the attribute name in the owner's index attributes, for example, "product.name"
owner: Type: string

Required: true

Specifies the owner of the index attributes, for example, system.

Body Parameter

The request body represents the partially updated index attribute.

Root Schema : Attribute

Type: object

Represents an index attribute. The object conforms to one of the following ecr-types:

context: Type: array context

Additional Properties Allowed:
derivedPropertyFunction: Type: string
derivedPropertySource: Type: string
displayConfig: Type: object DisplayConfig

Additional Properties Allowed:

Contains configuration on how to display an attribute and its values.
displayOrder: Type: integer
ecr:createDate: Type: string
ecr:lastModified: Type: string
ecr:lastModifiedBy: Type: string
ecr:type: Type: string

Allowed Values: [ "dimension", "property", "derived-property" ]
isAutogen: Type: boolean
isRecordSearchEnabled: Type: boolean
isWildcardEnabledInRecordSearch: Type: boolean
propertyDataType: Type: string
sourcePropertyNames: Type: array sourcePropertyNames

Additional Properties Allowed:

Nested Schema : context

Type: array

Nested Schema : DisplayConfig

Type: object

Contains configuration on how to display an attribute and its values.

sort: Type: string

This defines a list of sort options for sorting the values of this dimension. Each sort option is specified by a sort function, comma, sort order. Multiple sort options are separated by semicolons and any number of sort options may be specified. Possible sort functions are 'alpha', 'freq', and 'rank' and sort orders are 'asc' and 'desc'. For example, to sort by rank ascending and break ties by frequency descending use 'rank,asc;freq,desc'.

Nested Schema : sourcePropertyNames

Type: array

Security

basicAuth: Type: basic

Description: Basic username/password authentication.

Supported Media Types

202 Response

Index attribute successfully updated.

Body

Root Schema : Response

Type: object

Request Body Example

The following shows a sample request body to partially update an attribute in the specified owner index attributes list.

{
  "isRecordSearchEnabled": false,
  "ecr:type": "dimension"
}