List Items Create API

Purpose

Parameters

---

token string 100 required

Authentication token for either an application or session.

---

application string 200

Slug of application being requested. This is used to determine the role being used to make the request and therefore evaluate if the requester has the correct permissions.

---

session_view string 300

View of session object you would like returned.

---

view string 500

The view attribute controls what data is returned about the requested record.

---

key string 1000 required

The key describes the collection that this list_item will belong to. A list of all the collections can be found here https://planocore.planomatic.com/documentation/list_items.

---

slug string 1100 required

Unique slug of list_item in collection. This is the value that programatic logic may use depending on what the collection is used for.

---

name string 1300

Certain collections of list items require having a value for each list item. This attribute is used to hold that data.

---

description string 1400

In addition to a value, some collections of list items need a description. You can think of this attribute as additional elaboration of the list item if needed. Limit: 1000

---

notes string 1500

The notes attribute is helpful if any internal contexted is needed for a list item. For example, if a list item's name is changed but the slug isn't for programitic reasons, a note can be added here for future context.

---

active boolean 1600

The active attribute controls whether a list item in a collection is active. In most cases, this means that inactive list items don't show up in lists.

---

default boolean 1700

If default is passed as true, this list item will be marked as the sole default in the collection. If there was already a default list item in the collection, that list item will loose it's title as default.

---

external_id string 1800

In some cases, list items in a collection have an external_id associated to the item. For example, our collection of glip_teams have external Glip ids. https://planocore.planomatic.com/documentation/list_items/glip_team

---

item_type model 1900

In some cases, list items in a collection have records that they are associated to via polymorphic association. These associations can be made by specifying the model and id of the assoication. The item_type accepts a model class name which should be in CamelCase, e.g., Designation, OrderRequest. An example of a collection using this can be found in the client_designation_discovery collection. https://planocore.planomatic.com/documentation/list_items/client_designation_discovery

---

item_id integer 2000

This attribute is tied to the item_type param. When an item_type is passed the item_id is needed specifiy which record the list item is associated to. This can be seen in the assoication in https://planocore.planomatic.com/documentation/list_items/client_designation_discovery.

---

related_type model 2100

If an additional polymorphic association is needed in a list_item collection, you can used the related_type to specifiy the model of the second association in CamelCase, e.g., Designation, OrderRequest.

---

related_id integer 2200

This attribute is tied to the related_type param. When an related_type is passed the related_id is needed specifiy which record the list item is associated to.

Request Body Example: application/json

{"token": "Sw543vdfgswWg98", "application": "planoauth", "session_view": null, "view": "default", "key": "client_designation_discovery", "slug": "new_list_item", "name": "Value of list item", "description": "Description of list item", "notes": "Notes", "active": true, "default": true, "external_id": "123abc", "item_type": "Designation", "item_id": 2, "related_type": "Vendor", "related_id": 1}