Fields

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

Creating & Updating Custom Fields

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.

List of Supported fields

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

post

Creates new field

Query parameters

validation-levelinteger · int32Optional

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.

Body

modifiedstring · date-timeRead-onlyOptional

Last modification time.

Example: 2019-01-01T00:00:00

createdstring · date-timeRead-onlyOptional

Creation time.

Example: 2019-01-01T00:00:00

entity_namestringRead-onlyRequired

Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)

Example: string

namestringRequired

User friendly name for field.

Example: string

type_idstringRequired

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

Example: string

data_set_idstring · uuidOptional

Optional custom data set id can be set.

Example: 01234567-abcd-dcba-ffff-000000000000

calc_formulastringOptional

Calculated formula used for fields which supports calculation.

Example: string

default_valuestringOptional

A default value for field.

Example: string

is_uniquebooleanRead-onlyOptional

If true, then there will be an API validation if value of entity is unique.

Example: false

Responses

201

Creation confirmation. Returns created field

application/json

500

unexpected error

application / json

post

POST /api/v100/rest/spaces/<space_id>/entities/Fields HTTP/1.1
Host: us-east.pipelinersales.com
Content-Type: application / json
Accept: */*
Content-Length: 138

{
  "name": "string",
  "type_id": "string",
  "data_set_id": "01234567-abcd-dcba-ffff-000000000000",
  "calc_formula": "string",
  "default_value": "string"
}

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "has_draft": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "entity_name": "string",
    "api_name": "string",
    "name": "string",
    "use_lang": 1,
    "column_name": "string",
    "column_source": 1,
    "relation_id": "string",
    "relation_with_entity_id": "string",
    "shared_with_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "system_type": 1,
    "type_id": "string",
    "composite_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "data_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_data_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "calc_formula": "string",
    "default_value": "string",
    "sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "system_required": false,
    "is_published": false,
    "system_readonly": false,
    "use_in_global_search": false,
    "settings": {},
    "is_unique": false,
    "data_set": "https://example.com",
    "sequence_pattern": "string",
    "is_available_for_webresource": false,
    "lookup": {},
    "rollup": {},
    "options": {},
    "source_field_id": "string",
    "source_type_id": "string",
    "use_in_interface_preview": false,
    "translated_name": "string",
    "field_permissions": "https://example.com",
    "primitive_type": "string"
  }
}

POST {{baseUrl}}/entities/Fields
{
    "name": "Dropdown field example",
    "type_id": "dropdown",
    "entity_name": "Account",
    "data_set": [
        {"option_name": "Option 1", "calc_value": 1},
        {"option_name": "Option 2", "calc_value": 2},
        {"option_name": "Option 3", "calc_value": 3},
    ]
}

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

Update Existing custom field

For example, when you want to add a new option to the dropdown, you can update the existing custom field

patch

Modifies field or Fields with given id(s)

Path parameters

idstring · uuidRequired

ID of field to update

Query parameters

validation-levelinteger · int32Optional

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.

Body

namestringOptional

User friendly name for field.

Example: string

calc_formulastringOptional

Calculated formula used for fields which supports calculation.

Example: string

default_valuestringOptional

A default value for field.

Example: string

Responses

200

Modification confirmation. Returns resulting field

application/json

404

Sent when invalid ID is given

application / json

500

unexpected error

application / json

patch

PATCH /api/v100/rest/spaces/<space_id>/entities/Fields/{id} HTTP/1.1
Host: us-east.pipelinersales.com
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "string",
  "calc_formula": "string",
  "default_value": "string"
}

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "has_draft": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "entity_name": "string",
    "api_name": "string",
    "name": "string",
    "use_lang": 1,
    "column_name": "string",
    "column_source": 1,
    "relation_id": "string",
    "relation_with_entity_id": "string",
    "shared_with_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "system_type": 1,
    "type_id": "string",
    "composite_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "data_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_data_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "calc_formula": "string",
    "default_value": "string",
    "sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "system_required": false,
    "is_published": false,
    "system_readonly": false,
    "use_in_global_search": false,
    "settings": {},
    "is_unique": false,
    "data_set": "https://example.com",
    "sequence_pattern": "string",
    "is_available_for_webresource": false,
    "lookup": {},
    "rollup": {},
    "options": {},
    "source_field_id": "string",
    "source_type_id": "string",
    "use_in_interface_preview": false,
    "translated_name": "string",
    "field_permissions": "https://example.com",
    "primitive_type": "string"
  }
}

Patch {{baseUrl}}/entities/<field_id>
{
    "name": "Updated Dropdown field example",
    "data_set": [
        {"id": "123456"}, // id of existing dropdown option 1
        {"id": "654321"}, // id of existing dropdown option 2
        {"id": "456789", "optiona_name": "Updated Option 3"}, // id of existing dropdown option 3
        {"option_name": "New Option 4", "calc_value": 3},  // new dropdown option 4
    ]
}

Get All fields

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

get

Returns all defined Fields

Query parameters

include-deletedbooleanOptional

if enabled, deleted Fields are returned as well

firstinteger · int32Optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

lastinteger · int32Optional

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.

beforebooleanOptional

Cursor until which to take entities to result set.

afterbooleanOptional

Cursor after which to start taking entities to result set.

expandstringOptional

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.

Example: expand=owner,sales_unit,account_relations.account

order-bystringOptional

Order 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.

Example: order-by=created,-modified

filterobjectOptional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

Example: filter[name]=Example

filter-opobjectOptional

Filter 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].

Example: filter-op[name]=eq

load-onlystringOptional

Loads 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.

Example: load-only=id,name,owner.id

Responses

200

list of Fields

application/json

500

unexpected error

application / json

get

GET /api/v100/rest/spaces/<space_id>/entities/Fields HTTP/1.1
Host: us-east.pipelinersales.com
Accept: */*

{
  "success": true,
  "data": [],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

"data": [
        {
            "is_delete_protected": false,
            "has_draft": false,
            "id": "00000001-0001-a001-0040-000000000001",
            "is_deleted": false,
            "modified": "2020-09-21 10:16:11.968255+00:00",
            "created": "2020-09-21 10:16:12.334879+00:00",
            "entity_name": "Task",
            "api_name": "sf_jira_issue_link2",
            "name": "Jira Issue Link",
            "use_lang": 0,
            "column_name": "sf_jira_issue_link2_2",
            "column_source": 3,
       }
]

Get Field Values

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.

GET 
{{baseUrl}}/entities/Fields?expand=data_set&load-only=api_name,data_set.option_name&filter[api_name]=industry_id

"data": [
        {
            "api_name": "industry_id",
            "data_set": [
                {
                    "option_name": "Accounting"
                },
                {
                    "option_name": "Agriculture"
                },
                {
                    "option_name": "Broadcasting"
                }
                ...
    }
 ]

PreviousUnderstanding the CRM Concept NextAPI parameters

Last updated 3 years ago