Counting Rule

What can you do with CountingRule?


Properties

Property Details
id
"id": 373
Type: Number
This is the unique numeric identifier for the CountingRule
ownerId
"ownerId": 993
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
statusTierTypeId
"statusTierTypeId": 127
Type: Number
Unique identifier for the associated StatusTierType object.
countingRuleTypeId
"countingRuleTypeId": 214
Type: Number
Unique identifier for the associated CountingRuleType object.
isActive
"isActive": true
Type: Boolean
countIfUsage
"countIfUsage": true
Type: Boolean


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
  • statusTierTypeId
  • countingRuleTypeId
  • isActive
  • countIfUsage

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the CountingRule object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/CountingRule/{id:int}
Delete an instance of the CountingRule object.
GETapi/v1/CountingRule
Retrieve all of the CountingRule objects.
GETapi/v1/CountingRule/Metadata
Retrieve all of the meta data details of the CountingRule object.
GETapi/v1/CountingRule/Metadata/{option}
Retrieve all the meta data details of the CountingRule object based on provided options.
{option}Metadata options for the CountingRule object.
GETapi/v1/CountingRule/Paged
Retreive all of the CountingRule objects in a paged fashion.
GETapi/v1/CountingRule/Paged/Detail
Retreive all of the CountingRule objects in a paged fashion with all object details.
GETapi/v1/CountingRule/{id:int}
Retrieve an instance of the CountingRule object by it's ID.
{id:int}Unique identifier for the CountingRule object.
GETapi/v1/CountingRule/{id:int}/Detail
Retreive all of the Detail objects for the specified CountingRule.
{id:int}Unique identifier for the CountingRule object.
PATCHapi/v1/CountingRule/{id:int}
Update the CountingRule object and optionally make changes to any child objects.
POSTapi/v1/CountingRule
Create a new instance of the CountingRule object.
PUTapi/v1/CountingRule/{id:int}
Update an existing instance of the CountingRule object.