POST v1/CustomField/{customFieldId}/Lookup

Adds an approved custom field lookup to the specified custom field. The user is only allowed to do this if the 'CanAddLookup' property on the CustomField is true. When added, the ApprovedBy and ApprovedDate fields will be set to the current date and the current username. If the call is successful, the field value can be used immediately.

Roles Allowed

admin, editor

Request Information

URI Parameters

Name	Description	Type	Additional information
customFieldId		integer	Required

Body Parameters

CustomFieldLookupCreate

Name	Description	Type	Additional information
CustomFieldValue	The actual value for the CustomFieldLookup	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomFieldValue": "sample string 1"
}

application/xml, text/xml

Sample:

<CustomFieldLookupCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <CustomFieldValue>sample string 1</CustomFieldValue>
</CustomFieldLookupCreate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HTTP 201 on success with the CustomFieldLookup data, HTTP 404 if custom field not found, HTTP 403 if user is not allowed to add a lookup, HTTP 409 with existing CustomFieldLookup if the CustomFieldLookup already exists, HTTP 409 if validation fails

CustomFieldLookup

Name	Description	Type	Additional information
CustomFieldLookupID	Unique identifier for the Custom Field Lookup	integer	None.
CustomFieldID	Unique identifier for the Custom Field	integer	None.
ApprovedBy	If approved, this tells us the user that approved this CustomFieldLookup. Once approved, this value will be returned as part of the lookup list.	string	None.
ApprovedDate	The date that this CustomFieldLookup was approved.	date	None.
CustomFieldValue	The actual value for the CustomFieldLookup	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomFieldLookupID": 1,
  "CustomFieldID": 2,
  "ApprovedBy": "sample string 3",
  "ApprovedDate": "2024-10-31T03:19:49.6839079+00:00",
  "CustomFieldValue": "sample string 4"
}

application/xml, text/xml

Sample:

<CustomFieldLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <CustomFieldValue>sample string 4</CustomFieldValue>
  <ApprovedBy>sample string 3</ApprovedBy>
  <ApprovedDate>2024-10-31T03:19:49.6839079+00:00</ApprovedDate>
  <CustomFieldID>2</CustomFieldID>
  <CustomFieldLookupID>1</CustomFieldLookupID>
</CustomFieldLookup>