We’ve made the difficult decision to sunset Hire by Google on September 1, 2020. Learn more.

REST Resource: tenants.customFieldSpecs

Resource: CustomFieldSpec

A custom field spec in Hire.

JSON representation
{
  "name": string,
  "description": string,
  "objectTypes": [
    enum (ObjectType)
  ],
  "fieldType": enum (FieldType),
  "optionValues": [
    string
  ]
}
Fields
name

string

The resource name of this custom field spec. This is generated by the service when a custom field spec is created. Name takes the form of "tenants/*/customFieldSpecs/*".

description

string

Description of custom field.

objectTypes[]

enum (ObjectType)

Types of object that this custom field spec refers to.

fieldType

enum (FieldType)

Type of field that the custom field holds.

optionValues[]

string

The values that can be held by the custom field if CustomFieldSpec.FieldType is CustomFieldSpec.FieldType.DROPDOWN.

ObjectType

Specifies the type of object.

Enums
OBJECT_TYPE_UNSPECIFIED Custom field spec refers to an unspecified object type.
CANDIDATE Custom field spec refers to a Candidate.
JOB Custom field spec refers to a Job.
APPLICATION Custom field spec refers to a Application.
USER Custom field spec refers to a User.

FieldType

Specifies the field type.

Enums
FIELD_TYPE_UNSPECIFIED Custom field is unspecified field type.
BOOL Custom field is a bool field type. Expected value is a bool.
SINGLE_LINE_TEXT Custom field is a single line of text. Expected value is a string.
MULTI_LINE_TEXT Custom field is multiple lines of text. Expected value is a string.
DROPDOWN Custom field is a dropdown field type. Expected value is one of the optionValues strings.

Methods

get

Get a custom field spec in Hire.

list

List the custom field spec in Hire.