Collection Type

What can you do with CollectionType?


Properties

Property Details
id
"id": 34
Type: Number
This is the unique numeric identifier for the CollectionType
name
"name": "Hello World"
Type: String
sortOrder
"sortOrder": 961
Type: Number


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • sortOrder

DataFlow PATCH objects:


End Points

DELETEapi/v1/CollectionType/{id:int}
Delete an instance of the CollectionType object.
GETapi/v1/CollectionType
Retrieve all of the CollectionType objects.
GETapi/v1/CollectionType/Metadata
Retrieve all of the meta data details of the CollectionType object.
GETapi/v1/CollectionType/Metadata/{option}
Retrieve all the meta data details of the CollectionType object based on provided options.
{option}Metadata options for the CollectionType object.
GETapi/v1/CollectionType/Paged
Retreive all of the CollectionType objects in a paged fashion.
GETapi/v1/CollectionType/{id:int}
Retrieve an instance of the CollectionType object by it's ID.
{id:int}Unique identifier for the CollectionType object.
POSTapi/v1/CollectionType
Create a new instance of the CollectionType object.
PUTapi/v1/CollectionType/{id:int}
Update an existing instance of the CollectionType object.