OrganizationFields
Create, update, delete, and query Organization Fields in Zendesk.
Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the 本製品.SELECT * FROM OrganizationFields WHERE Id = '123'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.
Insert
The Type, Title, and Key fields are required to insert. The types of custom fields that can be created are the following: text (default when no Type is specified), textarea, checkbox, date, integer, decimal, and regex (when Type is regex, RegexpForValidation is required too). Allowed for admins.
INSERT INTO OrganizationFields (Type, Title, Key) VALUES ('text', 'Support description', 'support_description')
You can also create a Lookup Relationships. A lookup relationship field is a custom field whose type is "lookup". This type of custom field gives you the ability to create a relationship from a source object to a target object. To create a lookup relationship fields, Type, Key and RelationshipTargetType columns are required. The Type column value must be "lookup". A suitable combination of Field, Operator and Value is required for insertion in RelationshipFilterAll and RelationshipFilterAny. Here is a list of the possible combinations: "https://developer.zendesk.com/documentation/ticketing/reference-guides/conditions-reference/#shared-conditions".
INSERT INTO OrganizationFieldsRelationshipFilterAll#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved') INSERT INTO OrganizationFieldsRelationshipFilterAny#temp(Field, Operator, Value) VALUES('status', 'less_than', 'solved') INSERT INTO OrganizationFields (Type, Title, Key, RelationshipTargetType, RelationshipFilterAll, RelationshipFilterAny) VALUES ('lookup', 'Support description', 'support_description5', 'zen:ticket', 'OrganizationFieldsRelationshipFilterAll#temp', 'OrganizationFieldsRelationshipFilterAny#temp')
Update
You must specify the Id of the organization field to update. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for admins.
UPDATE OrganizationFields SET Title = 'Updated title' WHERE Id = '123'
Delete
You must specify the Id of the organizational field to delete it. Allowed for admins.
DELETE FROM OrganizationFields WHERE Id = '123'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | False |
Automatically assigned upon creation. | |
Key | String | False |
A unique key that identifies this custom field. Required on create.This is used for updating the field and referencing in placeholders. After a field is created, you cannot change its key. | |
Type | String | False |
Type of the custom field: checkbox, date, decimal, dropdown, integer, regexp, text, or textarea. After a field is created, you cannot change its type. | |
Title | String | False |
The title of the custom field. | |
RawTitle | String | False |
The dynamic content placeholder, if present, or the title value, if not. | |
Description | String | False |
User-defined description of this field s purpose. | |
RawDescription | String | False |
The dynamic content placeholder, if present, or the description value, if not. | |
Position | Integer | False |
Ordering of the field relative to other fields. | |
Active | Boolean | False |
If true, this field is available for use. | |
System | Boolean | False |
If true, only active and position values of this field can be changed. | |
RegexpForValidation | String | False |
Regular expression field only. The validation pattern for a field value to be deemed valid.. | |
CreatedAt | Datetime | False |
The time the ticket field was created. | |
UpdatedAt | Datetime | False |
The time of the last update of the ticket field. | |
Tag | String | False |
Optional for custom field of type checkbox; not presented otherwise. | |
CustomFieldOptions | String | False |
Required and presented for a custom field of type dropdown. | |
Url | String | False |
The URL for this resource. | |
RelationshipFilterAll | String | False |
A filter definition that allows your autocomplete to filter down results with Logical AND. | |
RelationshipFilterAny | String | False |
A filter definition that allows your autocomplete to filter down results with Logical OR. | |
RelationshipTargetType | String | False |
A representation of what type of object the field references. Options are zen:user, zen:organization, zen:ticket, or zen:custom_object:CUSTOM_OBJECT_KEY. For example zen:custom_object:apartment. |