Get Attribute

GET 
/attributes/:key

Returns a attribute

Request

Path Parameters

key stringrequired

Key Identifier

Query Parameters

siteId string

Site Identifier

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

attribute

object

type AttributeType (string)

Type of Attribute

Possible values: [STANDARD, OPA]

Default value: STANDARD

key string

Attribute Key

dataType AttributeDataType (string)

Data Type of Attribute

Possible values: [STRING, NUMBER, BOOLEAN, KEY_ONLY, PUBLICATION, WATERMARK]

Default value: STRING

watermark

object

text string

Watermark text

rotation number

Watermark Rotation

imageDocumentId string

Watermark Image Document Id

scale WatermarkScale (string)

Watermark Scale

Possible values: [FIT_BEST, ORIGINAL]

position

object

xAnchor WatermarkPositionXAnchor (string)

Watermark X Position Anchor

Possible values: [LEFT, RIGHT, CENTER]

yAnchor WatermarkPositionYAnchor (string)

Watermark Y Position Anchor

Possible values: [TOP, BOTTOM, CENTER]

xOffset number

X offset

yOffset number

Y offset

Example (from schema)

{
  "attribute": {
    "type": "STANDARD",
    "key": "string",
    "dataType": "STRING",
    "watermark": {
      "text": "string",
      "rotation": 0,
      "imageDocumentId": "string",
      "scale": "FIT_BEST",
      "position": {
        "xAnchor": "LEFT",
        "yAnchor": "TOP",
        "xOffset": 0,
        "yOffset": 0
      }
    }
  }
}

Loading...