ROrocketlane
Fields

Create a Field

Changed on

Create a custom field for PROJECT, TASK, USER, or COMPANY object types. fieldType NOTE is allowed for PROJECT and COMPANY. For NOTE fields, optional fieldOptions are stored as tags.

post/1.0/fields

Request

Query parameters

includeFieldsstring[]

This query parameter allows you to specify which field properties should be returned in the response body by selecting from the drop down. To get the relevant field properties, use comma separated values. If this field is left blank, the default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the field properties should be returned in the response body. If the field is left blank, the default field properties are returned.

Request body

fieldIdinteger

The field's unique, system-generated identifier, which can be used to identify the field globally.

fieldLabelstring required

The fieldLabel is the name of the field.

fieldDescriptionstring

The description of the field.

fieldType'TEXT' | 'MULTI_LINE_TEXT' | 'YES_OR_NO' | 'DATE' | 'SINGLE_CHOICE' | 'MULTIPLE_CHOICE' | 'SINGLE_USER' | 'MULTIPLE_USER' | 'NUMBER' | 'NOTE' | 'RATING' required

This defines type of the field. Refer Custom Fields for further information

objectType'PROJECT' | 'TASK' | 'USER' | 'BUDGET' | 'COMPANY' required

This defines type of object that is associated with the field. This could be TASK, PROJECT, USER, BUDGET or COMPANY.

ratingScale'THREE' | 'FIVE' | 'SEVEN' | 'TEN'

The number of stars in the Rating Scale when Field Type is RATING.

enabledboolean

This depicts if the field is enabled or not. Only those fields which are enabled will reflect in the account.

privateboolean

This depicts if the field is private or not.

Example request

{
  "fieldId": 201,
  "fieldLabel": "Priority",
  "fieldDescription": "Priority of the bug.",
  "fieldType": "MULTI_LINE_TEXT",
  "objectType": "PROJECT",
  "fieldOptions": [
    {
      "optionColor": "RED",
      "optionLabel": "High"
    }
  ],
  "ratingScale": "THREE"
}

Response

The resource was successfully created in the database.

fieldIdinteger

The field's unique, system-generated identifier, which can be used to identify the field globally.

fieldLabelstring

The fieldLabel is the name of the custom field

fieldDescriptionstring

The description of the field

fieldType'TEXT' | 'MULTI_LINE_TEXT' | 'YES_OR_NO' | 'DATE' | 'SINGLE_CHOICE' | 'MULTIPLE_CHOICE' | 'SINGLE_USER' | 'MULTIPLE_USER' | 'NUMBER' | 'NOTE' | 'RATING'

This defines type of the field. Refer Custom Fields for further information

objectTypestring

This defines type of object that is associated with the field. This could be TASK, PROJECT, USER, BUDGET or COMPANY.

ratingScale'THREE' | 'FIVE' | 'SEVEN' | 'TEN'

The number of stars in the Rating Scale when Field Type is RATING.

createdAtinteger

The time when the field was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the field was last updated. Any changes that's related to the field are captured and specified here in epoch millis.

enabledboolean

This depicts if the field is enabled or not. Only those fields which are enabled will reflect in the account.

privateboolean

This depicts if the field is private or not.

Example response

{
  "fieldId": 201,
  "fieldLabel": "MRR",
  "fieldDescription": "Priority of the bug.",
  "fieldType": "MULTI_LINE_TEXT",
  "objectType": "TASK",
  "fieldOptions": [
    {
      "optionValue": 2,
      "optionLabel": "Todo",
      "optionColor": "RED"
    }
  ],
  "ratingScale": "THREE",
  "createdBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "updatedBy": {
    "emailId": "john.doe@rocketlane.com",
    "userId": 201,
    "firstName": "John",
    "lastName": "Doe"
  },
  "createdAt": 1681319726000,
  "updatedAt": 1681319726000
}

Changes

  • a002a499e6fcRevision changes
    • info

      added the new BUDGET enum value to the request property

    • info

      added the new COMPANY enum value to the request property