Condition Field Type

(API Version v10)

What can you do with ConditionFieldType?

GET Usage/Rate/Group/ConditionFieldType/
Retrieve all of the ConditionFieldType objects.
GET Usage/Rate/Group/ConditionFieldType/Paged
Retrieve all of the ConditionFieldType objects in a paged fashion.
GET Usage/Rate/Group/ConditionFieldType/{id}
Retrieve an instance of the ConditionFieldType object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 12 Type: Number This is the unique numeric identifier for the ConditionFieldType
name	"name": "Hello World" Type: String
field	"field": "Hello World" Type: String
conditionTableTypeId	"conditionTableTypeId": 5 Type: Number Unique identifier for the associated ConditionTableType object.
conditionTableTypeName	"conditionTableTypeName": "Sample Name" Type: String The name of the object associated with the conditionTableTypeId property.
dataSourceColumnDataTypeId	"dataSourceColumnDataTypeId": 25 Type: Number Unique identifier for the associated DataSourceColumnDataType object.
dataSourceColumnDataTypeName	"dataSourceColumnDataTypeName": "Sample Name" Type: String The name of the object associated with the dataSourceColumnDataTypeId property.

End Points

Retrieve all of the ConditionFieldType objects.

GET Usage/Rate/Group/ConditionFieldType/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "field": "Sample Text Data",
            "conditionTableTypeId": 18,
            "conditionTableTypeName": "Sample Text Data",
            "dataSourceColumnDataTypeId": 10,
            "dataSourceColumnDataTypeName": "Sample Text Data"
        }
    ]
}

Retrieve all of the ConditionFieldType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.

Retrieve all of the ConditionFieldType objects in a paged fashion.

GET Usage/Rate/Group/ConditionFieldType/Paged

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "field": "Sample Text Data",
                "conditionTableTypeId": 4,
                "conditionTableTypeName": "Sample Text Data",
                "dataSourceColumnDataTypeId": 10,
                "dataSourceColumnDataTypeName": "Sample Text Data"
            }
        ]
    }
}

GET	Usage/Rate/Group/ConditionFieldType/{id}
Retrieve an instance of the ConditionFieldType object by its ID.
{id}	Unique identifier for the ConditionFieldType object.
Retrieve an instance of the ConditionFieldType object by its ID. GET Usage/Rate/Group/ConditionFieldType/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Sample Text Data", "field": "Sample Text Data", "conditionTableTypeId": 10, "conditionTableTypeName": "Sample Text Data", "dataSourceColumnDataTypeId": 8, "dataSourceColumnDataTypeName": "Sample Text Data" } }