field

Return a particular field by id

get/v1/org/{orgId}/field/{fieldId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/field/{fieldId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

fieldIdstring required

Field id

Response

successful operation

idstring required

globally unique id

orgIdstring

parent organization id (empty if global)

namestring required

short field name

labelstring required

human-readable full name of field

descriptionstring

description of field

inUseboolean

disallow any updates to this Field (except for field.question string)

exprstring

calculated expression

exprType'ADDRESS' | 'ALLOCATIONS' | 'AUDIO' | 'BOOLEAN' | 'COMP' | 'COMPOUND' | 'COMP_BAND' | 'CONTACTS' | 'CURRENCY' | 'DATE' | 'DECIMAL' | 'ELAPSED_DAYS' | 'ELAPSED_MONTHS' | 'ELAPSED_YEARS' | 'EMAIL' | 'ENUM' | 'ENUM_EXPR' | 'ENUM_MULTI' | 'ENUM_SCALE' | 'EXPR' | 'FILE' | 'GROUP' | 'GROUPS' | 'GROUP_ASSIGNMENTS' | 'GROUP_TYPE' | 'GROUP_POSITION_ASSIGNMENTS' | 'IMAGE' | 'INTEGER' | 'JOB' | 'JOB_CODE' | 'JOBS' | 'JOB_TIER' | 'LIST' | 'MAP' | 'MONEY' | 'NAME' | 'OBJECT' | 'PAY_INTERVAL' | 'PERCENT' | 'PERSON' | 'PERSONS' | 'PHONE' | 'STOCKGRANT' | 'STRING' | 'TABLE_REF' | 'TEXT' | 'TIMEOFF' | 'TIMESTAMP' | 'TRACKED_GROUP' | 'URL' | 'USER' | 'VARIABLE_COMP' | 'VARIABLE_COMPS'

the expected type of the evaluated expression

type'ADDRESS' | 'ALLOCATIONS' | 'AUDIO' | 'BOOLEAN' | 'COMP' | 'COMPOUND' | 'COMP_BAND' | 'CONTACTS' | 'CURRENCY' | 'DATE' | 'DECIMAL' | 'ELAPSED_DAYS' | 'ELAPSED_MONTHS' | 'ELAPSED_YEARS' | 'EMAIL' | 'ENUM' | 'ENUM_EXPR' | 'ENUM_MULTI' | 'ENUM_SCALE' | 'EXPR' | 'FILE' | 'GROUP' | 'GROUPS' | 'GROUP_ASSIGNMENTS' | 'GROUP_TYPE' | 'GROUP_POSITION_ASSIGNMENTS' | 'IMAGE' | 'INTEGER' | 'JOB' | 'JOB_CODE' | 'JOBS' | 'JOB_TIER' | 'LIST' | 'MAP' | 'MONEY' | 'NAME' | 'OBJECT' | 'PAY_INTERVAL' | 'PERCENT' | 'PERSON' | 'PERSONS' | 'PHONE' | 'STOCKGRANT' | 'STRING' | 'TABLE_REF' | 'TEXT' | 'TIMEOFF' | 'TIMESTAMP' | 'TRACKED_GROUP' | 'URL' | 'USER' | 'VARIABLE_COMP' | 'VARIABLE_COMPS' required

type of field

plural'SINGLE' | 'LIST' | 'SET' required

plural type of the field (either SINGLE, LIST, or SET)

defaultValueobject

default value if field is not set

entityType'JOB' | 'JOB_OPEN' | 'JOB_FILLED' | 'PERSON' | 'CHANGE' | 'TABLE' | 'ORG' | 'USER' | 'NONE'

entity type of field

isUniqueboolean required

indicates that this field value is unique in conjunction with entityType PERSON or JOB

isRequiredboolean required

indicates that this field value is required

isEffectiveDatedboolean

indicates that this field value is effective-dated

aliasesstring[]

set of aliases for this field

groupTypeIdstring

if this is a group membership field, the group type ID it's for

calc'ADDRESS' | 'AGE' | 'ALLOCATIONS' | 'ALLOCATIONS_COUNT' | 'ALLOCATIONS_IS_OVERALLOCATED' | 'ALLOCATIONS_IS_UNDERALLOCATED' | 'ALLOCATIONS_TOTAL' | 'ANNIVERSARY' | 'ANNUAL_BASE_MONEY' | 'BACKFILL' | 'BAND' | 'BAND_RANGE' | 'BASE' | 'BASE_CAL_YEAR_PRORATED' | 'BASE_CAL_YTD' | 'BASE_COMP' | 'BASE_COMP_AMOUNT' | 'BASE_COMP_ANNUALIZED' | 'BASE_COMP_ANNUALIZED_AS_ORG_CURRENCY' | 'BASE_COMP_AS_ORG_CURRENCY' | 'BASE_COMP_CHANGES' | 'BASE_COMP_CURRENCY' | 'BASE_COMP_HOURS_PER_WEEK' | 'BASE_COMP_INTERVAL' | 'BASE_COMP_LAST_RAISE_DATE' | 'BASE_COMP_LAST_RAISE_MONTHS_SINCE' | 'BASE_COMP_LAST_RAISE_PAY' | 'BASE_COMP_LAST_RAISE_PAY_AS_ORG_CURRENCY' | 'BASE_COMP_LAST_RAISE_PERCENT' | 'BASE_COMP_LAST_RAISE_TYPE' | 'BASE_COMP_PAY' | 'BASE_COMP_PAY_AS_ORG_CURRENCY' | 'BASE_COMP_WEEKS_PER_YEAR' | 'BASE_FISCAL_YEAR_PRORATED' | 'BASE_FISCAL_YTD' | 'BASE_PRIMARY' | 'BASE_RAISE_AMOUNT' | 'BASE_RAISE_DATE' | 'BASE_RAISE_PERCENT' | 'BIRTH_DATE' | 'BIRTHDAY' | 'BONUS_TARGET' | 'BUDGET_COST' | 'CAL_YEAR_VEST_SHARES' | 'CAL_YEAR_VEST_VALUE' | 'CAN_APPROVE_CHANGE' | 'CAN_EDIT_JOB' | 'CASH_COMP' | 'CASH_COMP_LOCAL' | 'CHANGE' | 'CHANGE_ID' | 'COMMISSION_TARGET' | 'COMP' | 'COMP_CHANGE_PERCENT' | 'COMPA_RATIO_MID' | 'COMPA_RATIO_TARGET' | 'CONTACT' | 'CONTACTS' | 'COST' | 'COST_STATUS' | 'CREATE_DATE' | 'CURRENCY' | 'DATA' | 'DATE' | 'DATE_OF' | 'DAYS_ACTIVE' | 'DAYS_OFF' | 'DAYS_OFF_TAKEN' | 'DAYS_OFF_UPCOMING' | 'DAYS_OPEN' | 'DB' | 'DEPART' | 'DEPARTMENT' | 'DEPARTMENT_FUNC' | 'DIRECT_JOBS' | 'DIRECT_JOB_COUNT' | 'DIRECT_PERSON_COUNT' | 'DIRECT_PERSONS' | 'EMPLOYMENT' | 'END_DATE_JOB' | 'END_DATE_ORG' | 'ETHNICITY' | 'FISCAL_YEAR_COST' | 'GENDER' | 'GEOIP' | 'GEOIP_ADDRESS' | 'GRAND_MANAGER' | 'GRANT_SHARES' | 'GRANT_TYPE' | 'GRANT_VALUE' | 'GRANTS' | 'GROUP_IDS' | 'GROUPS_BY_TYPE' | 'GROUP_GOALS' | 'HEADCOUNT' | 'HISTORIC_BACKFILL' | 'HOUR' | 'HOURLY' | 'HOURLY_PRIMARY' | 'HOURS_PER_WEEK' | 'IMAGE' | 'INDIRECT' | 'INDIRECT_JOBS' | 'JOB' | 'JOB_ID' | 'JOB_CODE' | 'JOBCOUNT' | 'LAST_GRANT' | 'LAST_GRANT_DATE' | 'LAST_GRANT_ORIGINAL_VALUE' | 'LOCATION' | 'MANAGE_JOBS' | 'MANAGE_PERSONS' | 'MANAGER' | 'MANAGER_COUNT' | 'MANAGER_FILLED' | 'MANAGER_ID' | 'MANAGERS' | 'MANAGER_PERSON' | 'MANAGER_PERSONS' | 'ME' | 'MERGE_SCENARIO_ID' | 'NAME' | 'NAME_AUDIO' | 'NAME_TITLE' | 'NEXT_DAY_OFF' | 'NEXT_TIME_OFF' | 'NEXT_YEAR_VEST_SHARES' | 'NEXT_YEAR_VEST_VALUE' | 'NOTE' | 'NOOP' | 'OPEN' | 'ORG' | 'OWNER_GOALS' | 'PERSON' | 'PERSON_ID' | 'PLACEMENT' | 'PREV_DAY_OFF' | 'PREV_TIME_OFF' | 'PROMOTION' | 'PROMOTION_DATE' | 'PROPOSED' | 'Q' | 'RAISE_AMOUNT' | 'RAISE_DATE' | 'RAISE_PERCENT' | 'RAISE_PROMOTION_DATE' | 'REASON' | 'REGRET' | 'RELATIONSHIPS' | 'REMOTE_WORK_ADDRESS' | 'SCENARIO' | 'SCENARIO_CHANGED' | 'SENSITIVE' | 'SENSITIVE_FIELDS' | 'START_DATE' | 'START_DATE_JOB' | 'START_DATE_ORG' | 'START_DATE_LIFETIME' | 'START_DATE_PLANNED' | 'STATE' | 'STRIKE_PRICE' | 'SUPPORTER_GOALS' | 'TARGET_HOURS_PER_WEEK' | 'TARGET_WEEKS_PER_YEAR' | 'TEAM' | 'TENURE_JOB' | 'TENURE_ORG' | 'TENURE_LIFETIME' | 'TIMEZONE_OFFSET' | 'TITLE' | 'TITLE_DATE' | 'TODAY' | 'TOTAL_COMP' | 'TOTAL_COMP_LOCAL' | 'TOTAL_ORG_SHARES' | 'TOTAL_SHARES' | 'TOTAL_SHARES_VALUE' | 'UNDER_JOBS' | 'UNVESTED_SHARES' | 'UNVESTED_VALUE' | 'UPDATE' | 'USER_ACTIVE_DAYS' | 'USER_ACTIVE_DAYS_CONSECUTIVE' | 'USER_CAN_EDIT_COMP_FOR_JOB' | 'USER' | 'VARIABLE' | 'VARIABLE_AMOUNT' | 'VARIABLE_INTERVAL' | 'VARIABLE_PERCENT' | 'VARIABLE_PRIMARY' | 'VARIABLE_TARGET' | 'VARIABLE_TARGET_AMOUNT' | 'VARIABLE_TARGET_ANNUALIZED' | 'VARIABLE_TARGET_CURRENCY' | 'VARIABLE_TARGET_PERCENT' | 'VARIABLE_TARGET_TYPE' | 'VARIABLE_TARGETS' | 'VARIABLE_TARGETS_LAST_RAISE_DATE' | 'VARIABLE_TARGETS_LAST_RAISE_MONTHS_SINCE' | 'VARIABLE_TARGETS_LAST_RAISE_PAY' | 'VARIABLE_TARGETS_LAST_RAISE_PERCENT' | 'VARIABLE_COMP_CHANGES' | 'VARIABLE_TYPE' | 'VESTED_DATE' | 'VESTED_SHARES' | 'VESTED_VALUE' | 'WEEKS_PER_YEAR' | 'WORK_ADDRESS' | 'UPCOMING'

unique ID for the function that runs to calculate the value of this field. For native fields only

classification'COMPOUND'

indicates how this field is calculated (whether it's stored in the DB, evaluated through the expression service, or compound)

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE' required

sensitivity level of data

hideExprboolean

hide expression-derived values from non-sensitive users

expireDaysinteger

number of days after which the data becomes invalid

categoryIdstring

the category the field belongs to

categoryIdsstring[]

the categories the field belongs to

status'ACTIVE' | 'HIDDEN'

the status of the field

tableIdstring

the table id this field applies to, only applicable when EntityType equals TABLE

tableNamestring
readonlyboolean
builtInboolean
canOverrideSensitivityboolean
placesinteger

number of decimal places for money values

isAutoIncrementboolean

whenther this field should auto-increment. For unique STRING or INT fields only

shouldAutoAddValueboolean

Whether the values for ENUM or ENUM_MULTI field can be added automatically by syncs and CSV imports

overrideRevertobject
overrideNamestring
hasSubfieldsboolean
createIdstring

created by user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteAtstring

deleted timestamp

Example response

{
  "id": "588f7ee98f138b19220041a7",
  "orgId": "588f7ee98f138b19220041a7",
  "name": "summary",
  "label": "Job Summary",
  "description": "This field tracks the most recent performance rating for an individual.",
  "expr": "(base + variable) / 12",
  "values": [
    {
      "id": "588f7ee98f138b19220041a7"
    }
  ],
  "options": {
    "groupTypeIds": [
      "588f7ee98f138b19220041a7"
    ]
  },
  "groupTypeId": "588f7ee98f138b19220041a7",
  "categoryId": "588f7ee98f138b19220041a7",
  "categoryIds": [
    "588f7ee98f138b19220041a7"
  ],
  "tableId": "588f7ee98f138b19220041a7",
  "tableRef": {
    "tableId": "588f7ee98f138b19220041a7"
  },
  "createId": "588f7ee98f138b19220041a7",
  "createAt": "2017-01-24T13:57:52Z",
  "updateId": "588f7ee98f138b19220041a7",
  "updateAt": "2017-01-24T13:57:52Z",
  "deleteId": "588f7ee98f138b19220041a7",
  "deleteAt": "2017-01-24T13:57:52Z"
}

Changes

No recorded changes to this operation across all 22 revisions of this API.