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
Update a custom field value
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Custom Field Value Object
asterisk denotes required| Name | Description | Format | Attributes |
|---|---|---|---|
| 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 |
| 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 |
| 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 | 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. | |
| value | Value contained in the custom field | string | |
| version | Implements concurrency on this object | byte |
The Custom Field Value Object
CustomFieldValue 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:
CustomFieldValue
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 |
|---|---|---|
| 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 |
| 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. |
| 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. |
| value | Value contained in the custom field | string |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
[
{
"createdById": "70bf1200-1b35-4393-b945-eccfe8ab13b1",
"createdOn": "2024-12-12T05:26:59Z",
"customFieldId": "0a13c521-b122-4722-83e9-9a2a0762e7cf",
"entityId": "373bd509-393f-4dda-8089-25ac486d7b7c",
"entityType": null,
"id": "6e114d7e-9e91-4402-a2a7-881e667f6d8e",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2024-12-12T05:26:59Z",
"lastUpdatedById": "5bd1ef80-1c5f-4a9d-8a45-820560e9a416",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
]Update a CustomFieldValue
Use this method to update a custom field value. 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:
CustomFieldValue
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 |
|---|---|---|
| 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 |
| 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. |
| 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. |
| value | Value contained in the custom field | string |
| version | Implements concurrency on this object | byte |
Example Request
Example Response
{
"createdById": "4f2a3564-3c79-4202-a36e-1df31589f9e9",
"createdOn": "2024-12-12T05:26:59Z",
"customFieldId": "3bef8c83-22a5-47fe-8626-802cacb74b96",
"entityId": "29a9c8c1-4c3a-45c1-9849-a59a24eda4fa",
"entityType": null,
"id": "a32fe7d0-b958-44aa-96e2-702fd14dc730",
"integrationSourceId": "integrationSourceId",
"label": "label",
"lastUpdated": "2024-12-12T05:26:59Z",
"lastUpdatedById": "23dc0a45-1c98-4a6f-af72-d1160032eb93",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}