OPENAPI / COMPONENTS / SCHEMAS

Template Response Document Static Field Base

TemplateResponseDocumentStaticFieldBase

An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.

object10properties
api_idstring

A unique id for the static field.

namestring

The name of the static field.

typestringrequired

signerstring

The signer of the Static Field.

xinteger

The horizontal offset in pixels for this static field.

yinteger

The vertical offset in pixels for this static field.

widthinteger

The width in pixels of this static field.

heightinteger

The height in pixels of this static field.

requiredboolean

Boolean showing whether or not this field is required.

groupstring

The name of the group this field is in. If this field is not a group, this defaults to `null`.