Custom Field Value
Custom field values refer to the contents of custom fields linked to various CORE modules. The Custom Field Value API allows you to perform the following operations:
- Retrieve a list of custom field values
- Create a custom field value
- Update a custom field value
- Delete a custom field value
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Custom Field Value Object
asterisk denotes required| Name | Description | Format | Attributes |
|---|---|---|---|
| customFieldId | Identifier of the custom field to which the value is linked | uuid | |
| entityId | Identifier of the entity, e.g., project, employee, etc. to which the custom field value is linked | uuid | Filterable |
| entityType | Type of the entity to which the custom field value is linked, e.g., Project, Employee, etc. | ModuleNames Enumerated type: Click to see possible values and their descriptions. | Filterable, Sortable |
| value | Value contained in the custom field | string | |
| createdById | Identifier of the user who created this object | uuid | Filterable |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| description | Represents the selected custom list item for drop-down type custom fields. Note that the ‘value’ field for such custom fields contains the ‘id’ of the drop-down custom list. | string | |
| id | Object identifier | uuid | Filterable |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string | Filterable, Sortable |
| label | Name of the custom field | string | Filterable, Sortable |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState Enumerated type: Click to see possible values and their descriptions. | |
| token | Represents the token for update operations | int32 | |
| type | Type of the custom field, e.g., text, date, etc. | CustomFieldType Enumerated type: Click to see possible values and their descriptions. | |
| version | Implements concurrency on this object | byte |
The Custom Field Value Object
Custom Field Value List
Use this method to retrieve a list of custom field values. Optionally, pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned.
Request URL
base_url/customfieldvalue
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field Value
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| fields | Query | Specifies the model properties you want in the response body | string |
| where | Query | Specifies only those records that match an expression in the query | string |
| orderBy | Query | Specifies the order of the records | string |
| page | Query | Specifies the page number and number of records on each page | string |
| expand | Query | string |
Response Body
| Name | Description | Format |
|---|---|---|
| customFieldId | Identifier of the custom field to which the value is linked | uuid |
| entityId | Identifier of the entity, e.g., project, employee, etc. to which the custom field value is linked | uuid |
| entityType | Type of the entity to which the custom field value is linked, e.g., Project, Employee, etc. | ModuleNamesEnumerated type: Click to see possible values and their descriptions. |
| value | Value contained in the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| description | Represents the selected custom list item for drop-down type custom fields. Note that the ‘value’ field for such custom fields contains the ‘id’ of the drop-down custom list. | string |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| label | Name of the custom field | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| token | Represents the token for update operations | int32 |
| type | Type of the custom field, e.g., text, date, etc. | CustomFieldTypeEnumerated type: Click to see possible values and their descriptions. |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
[
{
"customFieldId": "406e2dfb-fde9-4d9e-a4ee-30296458b5b2",
"entityId": "8db753ab-8c76-4673-b554-e1f6b74a48ac",
"entityType": null,
"value": "value",
"createdById": "b2a4d94d-cbab-4893-af6f-e6fc3f69fb54",
"createdOn": "2025-04-24T05:08:28Z",
"description": "CustomFieldModelValue Description",
"id": "6037a70e-0117-439a-b001-da1a5a055851",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "afa51269-479d-4470-95cb-7e4d4215430c",
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]Create a Custom Field Value
Use this method to add a value in the custom field of an entity that previously had no value for that field. Pass a CustomFieldModelValue object as the parameter.
Request URL
base_url/customfieldvalue
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field Value
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | CustomFieldModelValue object | CustomFieldModelValue |
Response Body
| Name | Description | Format |
|---|---|---|
| customFieldId | Identifier of the custom field to which the value is linked | uuid |
| entityId | Identifier of the entity, e.g., project, employee, etc. to which the custom field value is linked | uuid |
| entityType | Type of the entity to which the custom field value is linked, e.g., Project, Employee, etc. | ModuleNamesEnumerated type: Click to see possible values and their descriptions. |
| value | Value contained in the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| description | Represents the selected custom list item for drop-down type custom fields. Note that the ‘value’ field for such custom fields contains the ‘id’ of the drop-down custom list. | string |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| label | Name of the custom field | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| token | Represents the token for update operations | int32 |
| type | Type of the custom field, e.g., text, date, etc. | CustomFieldTypeEnumerated type: Click to see possible values and their descriptions. |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
{
"customFieldId": "c6afff93-0f03-4a6d-b053-ec233d17c788",
"entityId": "06c96dc7-11a3-4b32-b913-79d6a20f96d5",
"entityType": null,
"value": "value",
"createdById": "1d93a8db-0df2-4ae5-b135-e224a149a612",
"createdOn": "2025-04-24T05:08:28Z",
"description": "CustomFieldModelValue Description",
"id": "6c037df1-5792-4e76-b258-d501fe82f039",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "b3af4c7a-50d1-485c-8afe-533b0cf70a82",
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Update a Custom Field Value
Use this method to update the value in the custom field of an entity. Pass id and CustomFieldModelValue object as the parameters.
Request URL
base_url/customfieldvalue/{id}
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Custom Field Value
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field value identifier | string |
| body | Body | CustomFieldModelValue object | CustomFieldModelValue |
Response Body
| Name | Description | Format |
|---|---|---|
| customFieldId | Identifier of the custom field to which the value is linked | uuid |
| entityId | Identifier of the entity, e.g., project, employee, etc. to which the custom field value is linked | uuid |
| entityType | Type of the entity to which the custom field value is linked, e.g., Project, Employee, etc. | ModuleNamesEnumerated type: Click to see possible values and their descriptions. |
| value | Value contained in the custom field | string |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| description | Represents the selected custom list item for drop-down type custom fields. Note that the ‘value’ field for such custom fields contains the ‘id’ of the drop-down custom list. | string |
| id | Object identifier | uuid |
| integrationSourceId | Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users | string |
| label | Name of the custom field | string |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| token | Represents the token for update operations | int32 |
| type | Type of the custom field, e.g., text, date, etc. | CustomFieldTypeEnumerated type: Click to see possible values and their descriptions. |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
{
"customFieldId": "78962080-9834-41bc-84ca-c64fea78e60e",
"entityId": "1bd00abc-c006-42ef-b9b2-21da702dab6a",
"entityType": null,
"value": "value",
"createdById": "5ef3690e-6474-4a24-993a-8910932b242e",
"createdOn": "2025-04-24T05:08:28Z",
"description": "CustomFieldModelValue Description",
"id": "805bd1a9-bd94-4e5a-9788-2fbcb9bbd308",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2025-04-24T05:08:28Z",
"lastUpdatedById": "bf9b1602-39e5-4d1d-b376-eed2f43bb514",
"objectState": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}Delete a Custom Field Value
Use this method to delete the value in the custom field of an entity. Pass id as the parameter.
Request URL
base_url/customfieldvalue/{id}
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Custom field value identifier | string |
Example Request