Jump to

• Request
• Response
• Examples

View owner attributes

get

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

Returns the specified owner index attributes. If zip extension is specified (add ".zip" at the end of the path), the owner attributes are exported as a zip file.

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.

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The specified owner index attributes.

Body ()

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>"
}

Back to Top

Examples

The following example shows how to view the index attributes of a specified owner in a given ECR application by submitting a GET request on the REST resource using cURL:

curl -u <username>:<password> http://localhost:8006/ifcr/gsadmin/v1/{appName}/attributes/{owner}

Response Body Example

The following example shows the response returned in JSON format.

{
  ecr:lastModifiedBy: "admin",
  ecr:lastModified: "2016-03-15T15:50:27.062Z",
  ecr:createDate: "2016-03-15T15:50:26.786Z",
  ecr:type: "attributes-owner-folder",
  camera.35_mm_camera_lens_equivalent: {
    ecr:lastModifiedBy: "admin",
    propertyDataType: "ALPHA",
    ecr:lastModified: "2016-03-15T15:50:27.062Z",
    sourcePropertyNames: [
      "camera.35 mm camera lens equivalent"
    ],
    ecr:createDate: "2016-03-15T15:50:26.811Z",
    ecr:type: "property"
  },
  camera.color: {
    isWildcardEnabledInRecordSearch: true,
    ecr:lastModifiedBy: "admin",
    ecr:lastModified: "2016-03-15T15:50:27.062Z",
    displayOrder: 4,
    sourcePropertyNames: [
      "camera.Colour of product"
    ],
    isAutogen: true,
    ecr:createDate: "2016-03-15T15:50:26.801Z",
    isRecordSearchEnabled: true,
    ecr:type: "dimension"
  },
  product.sku: {
    ecr:lastModifiedBy: "admin",
    propertyDataType: "ALPHA",
    ecr:lastModified: "2016-03-15T15:50:27.062Z",
    ecr:createDate: "2016-03-15T15:50:26.798Z",
    isRecordSearchEnabled: true,
    ecr:type: "property"
  }
}

Back to Top