Jump to

• Request
• Response
• Examples

Partial update owner attributes

patch

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

Partial updates the specified owner index attributes in the given application's index attributes list.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• owner: string
  Specifies the owner of the index attributes, for example, system.

Body ()

The request body represents the partially updated owner index attributes.

Root Schema : ConfigOwnerAttributes

Type: object

Represents a config owner's index attributes. Child nodes represent attributes conforming to one of the following ecr-types:

• dimension
• property
• derived-property

Show Source

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

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"attributes-owner-folder"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents a config owner's index attributes. Child nodes represent attributes conforming to one of the following ecr-types: \n <ul><li>dimension</li><li>property</li><li>derived-property</li></ul>"
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Owner 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 partially update owner index attributes.

{
  "ecr:type": "attributes-owner-folder",
  "product.min_price": {
    "derivedPropertySource": "product.price",
    "derivedPropertyFunction": "MIN",
    "ecr:type": "derived-property"
  }
}

Back to Top