Skip to content

Properties

idstring
required·

The unique identifier for the scorecard template

created_atstring · date-time

Creation time of the scorecard template

created_byobject

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

idstring

The unique identifier for a user

namestring

The name of the user

enabledboolean

Whether the scorecard template is enabled in the source system

fieldsobject[]

The scorecard fields

columnsobject[]

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

4 properties
descriptionstring

The column's description

labelstring

The column's label

optionsobject[]

The field's options

3 properties
descriptionstring

The option's description

labelstring

The option's label

valuestring

The option's value

valuestring

The column's value

descriptionstring

The field's description

field_groupobject

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

3 properties
idstring

The field groups's identifier

labelstring

The field groups's label

namestring

The field groups's name

formatstring

The format of the field.

Possible values:
urlemailpassword
idstring

The field's unique identifier

is_overallboolean

Whether this field is the overall summary question

is_requiredboolean

Whether the field is required

labelstring

The field's label

namestring

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

optionsobject[]

The field's options

3 properties
descriptionstring

The option's description

labelstring

The option's label

valuestring

The option's value

placeholderstring

The field's placeholder

positionnumber

The index position of field in the scorecard template.

rangeobject

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

4 properties
maxnumber

The maximum range for the field.

max_labelnumber

The label for the maximum range of the field.

minnumber

The minimum range for the field.

min_labelnumber

The label for the minimum range of the field.

rowsobject[]

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

3 properties
descriptionstring

The row's description

labelstring

The row's label

valuestring

The row's value

typestring

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

Possible values:
statementstringtextrich_textnumberbooleandatedatetimetimeenumarrayfile+ 5 more
validationstring

The validation string for the field.

namestring

Name of the scorecard template

remote_dataRecord<string, any>

Raw data returned from the remote API call.

review_methodstring

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

typestring

The type of the scorecard template in the source system

updated_atstring · date-time

Last updated time of the scorecard template

workspaceobject

The workspace to which the scorecard template belongs.

idstring

The unique identifier of the workspace.

namestring

The name of the workspace.