Jump to

• Request
• Response
• Examples

Update index attributes

put

/gsadmin/v1/{appName}/attributes

Updates one or more index attributes in the specified application.

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Body ()

The request body represents the updated index attributes.

Root Schema : IndexAttributes

Type: object

Represents index attributes of an application. Child nodes represent the config owner attributes conforming to ConfigOwnerAttributes JSON schema.

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: attributes-folder

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"attributes-folder"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents index attributes of an application. Child nodes represent the config owner attributes conforming to ConfigOwnerAttributes JSON schema."
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Index attributes successfully updated.

Body ()

Root Schema : Response

Type: object

Show Source

• message(optional): string
• status(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

Examples

Request Body Example

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

{
  "isWildcardEnabledInRecordSearch": true,
  "displayOrder": 4,
  "sourcePropertyNames": ["camera.Colour of product"],
  "isAutogen": true,
  "isRecordSearchEnabled": true,
  "ecr:type": "dimension"
}

Back to Top