List Provider

What can you do with ListProvider?


Properties

Property Details
id
"id": 765
Type: Number
This is the unique numeric identifier for the ListProvider
name
"name": "Hello World"
Type: String
listProviderTypeId
"listProviderTypeId": 66
Type: Number
Unique identifier for the associated ListProviderType object.
description
"description": "Hello World"
Type: String


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
  • value
  • listProviderTypeId

DataFlow PATCH objects:


End Points

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