Fields
Last updated
Last updated
Fields offer Pipeliner users the opportunity to add detailed information to the Entities - for example, Account Name, Address, Website, Phone numbers for Accounts and Opportunity Name, Close Date, Value for Opportunities. how to manage fields in Pipeliner
System & Custom Fields
System fields are automatically included in Pipeliner. These fields can´t be deleted.
Custom fields are defined by business/user. The business can create the fields based on their needs in the Administration.
Field Properties
Api Field Name - API name of the field. When working with API this is the name of the field, that you will use in the request/response
Type - Pipeliner supports several field types (dropdowns, date fields, line inputs etc.)
Field name - Name of the field in the Pipeliner Application
As a developer, you have an option to create custom fields through API. Not every field can be created through API though. In the table below you can find a list of supported fields.
Single Line text
input
Long Text
text_area
Dropdown
dropdown
Checkbox
checkbox
Multi select checkox
multiselect_checkbox
Radio Button
radio
Base Currency
currency
Multiple Currencies
currency_foreign
Date
date
DateTime
datetime
Float Number
float
Integer Number
integer
Autonumber
sequence
Url
url
Phone
phone
calc_value - For Dropdowns, Multi-select checkbox, Radio is required. Every option has a value and when this option is used in calculated field, it is calculated with this value. If you don´t plan to use options with calculated fields, you can just use "1" for all calc_values
entity_name - Account, Contact, Lead, Opportunity, Product, LeadOpptyProductRelation (Product Line Items), Task, Appointment, Project
For example, when you want to add a new option to the dropdown, you can update the existing custom field
To retrieve all fields use the following endpoint. Every field has a unique identification api_name. This is how you can filter fields, that you need to work with
Example
To get specific field valuies use a combination of and {{baseURL}}/entities/Fields endpoint
In this example we want to retrieve the values of the dropdown field with api field name industry_id. We use filter, one of the to find specific field by api_name.
Returns all defined Fields
if enabled, deleted Fields are returned as well
Number of entities to return from beginning of the result set. Max: 100. Default: 30
Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.
Cursor until which to take entities to result set.
Cursor after which to start taking entities to result set.
Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.
expand=owner,sales_unit,account_relations.accountOrder by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.
order-by=created,-modifiedUse name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.
filter[name]=ExampleFilter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].
filter-op[name]=eqLoads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.
load-only=id,name,owner.idCreates new field
Specify validation level of field on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.
Last modification time.
2019-01-01T00:00:00Creation time.
2019-01-01T00:00:00Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)
stringUser friendly name for field.
stringType of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url
stringOptional custom data set id can be set.
01234567-abcd-dcba-ffff-000000000000Calculated formula used for fields which supports calculation.
stringA default value for field.
stringIf true, then there will be an API validation if value of entity is unique.
falseModifies field or Fields with given id(s)
ID of field to update
Specify validation level of field on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.
User friendly name for field.
stringCalculated formula used for fields which supports calculation.
stringA default value for field.
string