Appearance

ScorecardTemplates Object ​


id
string
REQUIRED · 

The unique identifier for the scorecard template

name
string

Name of the scorecard template

type
string

The type of the scorecard template in the source system

enabled
boolean

Whether the scorecard template is enabled in the source system

review_method
string

Default review method for the template. Can be manual, automatic, or both.

fields
object[]

The scorecard fields

id
string

The field's unique identifier

name
string

The field's name. This is the name of the property in the entity.

label
string

The field's label

placeholder
string

The field's placeholder

description
string

The field's description

position
number

The index position of field in the scorecard template.

type
string

The field's type. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • statement
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • rating
  • slider
  • ranking
  • group
  • matrix
format
string

The format of the field.

All possible enum values:
  • url
  • email
  • password
validation
string

The validation string for the field.

range
object

The range applicable for field types number, rating, scale.

min
number

The minimum range for the field.

min_label
number

The label for the minimum range of the field.

max
number

The maximum range for the field.

max_label
number

The label for the maximum range of the field.

is_required
boolean

Whether the field is required

is_overall
boolean

Whether this field is the overall summary question

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

field_group
object

The field's group identifier. If present, the field is part of a group.

id
string

The field groups's identifier

name
string

The field groups's name

label
string

The field groups's label

rows
object[]

The field's rows. If present, the field's type is matrix

label
string

The row's label

value
string

The row's value

description
string

The row's description

columns
object[]

The field's columns. If present, the field's type is matrix

label
string

The column's label

value
string

The column's value

description
string

The column's description

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

workspace
object

The workspace to which the scorecard template belongs.

id
string

The unique identifier of the workspace.

name
string

The name of the workspace.

created_by
object

User who last updated the scorecard template in the source system.

id
string

The unique identifier for a user

name
string

The name of the user

created_at
string · date-time

Creation time of the scorecard template

updated_at
string · date-time

Last updated time of the scorecard template

remote_data
object

Raw data returned from the remote API call.