Jump to

• Request
• Response
• Examples

View index attributes

get

/gsadmin/v1/{appName}/attributes

Returns the index attributes for the specified application. Returns metadata about the attributes (e.g. who created it and when) along with a list of owner attributes. If zip extension is specified (add ".zip" at the end of the path), the 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".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The index attributes.

Body ()

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

Back to Top

Examples

The following example shows how to view the index attributes of an 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

Response Body Example

The following example shows the response returned in JSON format.

{
  "ecr:lastModifiedBy": "admin",
  "ecr:lastModified": "2016-02-26T14:38:53.102Z",
  "ecr:createDate": "2016-02-26T14:38:53.102Z",
  "ecr:type": "attributes-folder",
  "system": {
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-02-26T14:38:53.103Z",
    "ecr:createDate": "2016-02-26T14:38:53.103Z",
    "ecr:type": "attributes-owner-folder"
  }
}

Back to Top