RateRulesPolicyItemResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

results object

A rate rules policy.

iduuid

The internal ID of the resource or object.

In general, the id field is the primary key of the object and cannot be changed or updated.

Example: 64BBA147B9AC41D9978062300826C89F

uriuri-reference

The URI associated with this resource. This is usually a relative URL that can be used to access the resource. Typically it incorporates the Unique ID of the resource.

Example: /api/v1/objects/64BBA147B9AC41D9978062300826C89F

tablenamestring

The name of the internal database table associated with this resource.

Example: users

table_labelstring

The user-visible label of the database table associated with this object.

Example: codes_pay_types

creatorstring

The internal User ID of the user who created the object.

Example: 64BBA147B9AC41D9978062300826C89F

create_timestampfloat

The timestamp when the object was created, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

modifierstring

The internal User ID of the user who most recently modified the object.

Example: 64BBA147B9AC41D9978062300826C89F

modify_timestampfloat

The timestamp when the object was most recently modified, in Unix epoch format. This is the number of seconds since 1970-01-01T00:00:00Z.

Example: 1696021987.01375

id_domainstring

The internal Domain ID of the resource or object. In general, this field is deprecated and not in use and can be ignored.

Example: install_root_dom

context_classstring

Always set to RateFlow for a Policy.

Possible values: [RateFlow]

Example: RateFlow

descendantsnumber

Always set to 0.0 for a Policy.

Example: 0

descriptionstring

The description of the policy.

Example: This is a rate rules policy.

footerstring

Always null for a Policy.

Example: null

headerstring

Always null for a Policy.

Example: null

id_rulestring

The unique internal ID of the policy. Same as the id field. Unlike most other object types, the ID will be composed of the install_root_dom constant plus the `pname`` field.

Example: install_root_domTestPolicy

pnamestring

The name of the policy.

Example: Billing Policy

python_1string

Internal field.

python_2string

Internal field.

python_3string

Internal field.

python_4string

Internal field.

python_5string

Internal field.

python_6string

Internal field.

python_7string

Internal field.

python_8string

Internal field.

python_9string

Internal field.

python_10string

Internal field.

rejectednumber

Always set to 0.0 for a Policy.

Example: 0

subtypestring

Always set to RuleSet for a Policy.

Possible values: [RuleSet]

Example: RuleSet

typestring

Always set to JxRule for a Policy.

xml_1string

Internal field.

xml_2string

Internal field.

xml_3string

Internal field.

xml_4string

Internal field.

xml_5string

Internal field.

xml_6string

Internal field.

xml_7string

Internal field.

xml_8string

Internal field.

xml_9string

Internal field.

xml_10string

Internal field.

xml_11string

Internal field.

xml_12string

Internal field.

xml_13string

Internal field.

xml_14string

Internal field.

xml_15string

Internal field.

successboolean

Indicates whether the request was successful (normally true if it's not an error response)

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

RateRulesPolicyItemResponse

{
  "response_code": 200,
  "results": {
    "id": "64BBA147B9AC41D9978062300826C89F",
    "uri": "/api/v1/objects/64BBA147B9AC41D9978062300826C89F",
    "tablename": "users",
    "table_label": "codes_pay_types",
    "creator": "64BBA147B9AC41D9978062300826C89F",
    "create_timestamp": 1696021987.01375,
    "modifier": "64BBA147B9AC41D9978062300826C89F",
    "modify_timestamp": 1696021987.01375,
    "id_domain": "install_root_dom",
    "context_class": "RateFlow",
    "descendants": 0,
    "description": "This is a rate rules policy.",
    "footer": null,
    "header": null,
    "id_rule": "install_root_domTestPolicy",
    "pname": "Billing Policy",
    "python_1": "string",
    "python_2": "string",
    "python_3": "string",
    "python_4": "string",
    "python_5": "string",
    "python_6": "string",
    "python_7": "string",
    "python_8": "string",
    "python_9": "string",
    "python_10": "string",
    "rejected": 0,
    "subtype": "RuleSet",
    "type": "string",
    "xml_1": "string",
    "xml_2": "string",
    "xml_3": "string",
    "xml_4": "string",
    "xml_5": "string",
    "xml_6": "string",
    "xml_7": "string",
    "xml_8": "string",
    "xml_9": "string",
    "xml_10": "string",
    "xml_11": "string",
    "xml_12": "string",
    "xml_13": "string",
    "xml_14": "string",
    "xml_15": "string"
  },
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users"
}