This tutorial should help you create the first Custom Entity record. Before moving forward, make sure your Authentication works and you understand the Key Concepts of the Pipeliner API and make sure you know how to use API parameters
The Custom Entity allows user to work with a completely new type of entity in Pipeliner. You can create Custom Entity records and link them with other entities using Lookup fields.
Tutorial Assignment
Create Custom Entity record with the particular Entity Type
Link Custom Entity record to Opportunity using Lookup field
Filter existing Custom entity record by custom field
0. Required fields
Required API field Name
Description
name
Name of the custom entity record
owner_id
Id of the User in Pipeliner Application
type_id
Id of the related Custom Entity Expected Closing date.
1. Prepare Data
Owner_id
Load an id of the user with the default sales unit.This user will become the owner of the newly created Custom Entity Record.
We don´t necessarily need to load the default unit id. If only owner_id is specified in the final request, Pipeliner will automatically create the opportunity with the default User´s sales unit. (See step 2. of this tutorial)
Type_id
Pull Custom Entity Types. Store the ID of the Custom Entity Type
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.
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.
