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. Learn more about how to manage fields in Pipeliner
To view fields inside Pipeliner Interface, you need to move the field to the Entity form.
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.
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
To get specific field valuies use a combination of API paremeters and {{baseURL}}/entities/Fields endpoint
Example
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 API parameters to find specific field by api_name.
| Name | Type_id |
|---|---|
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
Creates new field
data of new Field
Last modification time.
"2019-01-01T00:00:00"Creation time.
"2019-01-01T00:00:00"Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)
"string"User friendly name for field.
"string"Type 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
"string"Optional custom data set id can be set.
"01234567-abcd-dcba-ffff-000000000000"Calculated formula used for fields which supports calculation.
"string"A default value for field.
"string"If true, then there will be an API validation if value of entity is unique.
falseCreation confirmation. Returns created field
True when response succeeded, false on error.
trueReturns all defined Fields
list of Fields
True when response succeeded, false on error.
truePage info result set. Please note it is returned only when legacy limit & offset parameters are not used.
Modifies field or Fields with given id(s)
ID of field to update
id(s) of modified item(s) and fields to modify
User friendly name for field.
"string"Calculated formula used for fields which supports calculation.
"string"A default value for field.
"string"Modification confirmation. Returns resulting field
True when response succeeded, false on error.
true
