Create a usage rule definition

This POST operation adds a usage rule definition to an existing plan definition by using the usageRuleDefinitions endpoint as well as a JSON payload creating the usage rule. If successful, you receive an HTTP response code of 201 and a JSON response containing the new usage rule definition information.

See HTTP response codes for other response codes.

POST /pcc/spcm/planDefinitions/<planDefinitionId>/usageRuleDefinitions + JSON payload

HEADER INFO

tenant: <tenantName>

authorisation: HTTP Basic Auth

content-type: application/hal+JSON

accept: application/hal+JSON

permissions: SPCM_PLAN_DEFINITION_CREATE_PERMISSION

URL parameters

There are is one mandatory parameter.

Parameter Type Description

planDefinitionId

integer

A unique identifier for a plan definition which was assigned by the server upon creating the plan definition.


JSON payload

{
    "name": "fairUsageRule",
    "summary": null,
    "threshold": 100,
    "maxDeactivationPeriod": null,
    "updateType": "NONE"
}


JSON response

The following example shows a JSON response when creating a new usage rule definition with the name fairUsageRule. Note the id of 730 which is auto-assigned.

{
    "id": 730,
    "name": "fairUsageRule",
    "summary": null,
    "threshold": 100,
    "maxDeactivationPeriod": null,
    "updateType": "NONE",
    "_links": {
        "pccProfiles": {
            "href": "http://localhost:8080/spcm-rest-ws/pcc/spcm/planDefinitions/167/usageRuleDefinitions/730/pccProfiles"
        },
    "usageCounterDefinitions": {
        "href": "http://localhost:8080/spcm-rest-ws/pcc/spcm/planDefinitions/167/usageRuleDefinitions/730/usageCounterDefinition"
            },
    "self": {
        "href": "http://localhost:8080/spcm-rest-ws/pcc/spcm/planDefinitions/
        167/usageRuleDefinitions/730"
            }
        }
}


Usage rule definition type descriptions

Field Type Description

id

integer

The unique identifier for the usage rule. This is assigned by the server upon creation.

mandatory (on update)

name

string

The name of the usage rule.

mandatory

threshold

integer

The threshold (in bytes) at which the rule is violated.

mandatory

summary

string

A summary of the usage rule definition.

maxDeactivationPeriod

string

The maximum period of time that which a subscriber can deactivate a usage rule. Format: Xminute,Xhour,Xday,Xweek,Xmonth

mandatory if updateType is ALL.

updateType

enum

Specifies the update type.

possible values

  • all = rule can be updated

  • none = rule cannot be updated

HTTP response codes

Code Description

201/204

success!

If you receive a 204 code, you will not see a JSON response.

207

Multistatus response

Check out HTTP statuses for more details.
This is not applicable to all operations.

400

malformed request

401

unauthorised; bad username or password

403

forbidden; user does not have appropriate privileges

404

usage rule definition not found

409

conflict with target resource

This often occurs if the item already exists, such as a plan, group, or name.
This is not applicable to all operations.

412

failed validation; this typically means that a property was not set or a value is out of range.

example
HTTP 412
{
  "errors" : [
        {
          "field" : "name",
          "description" : "name is mandatory"
        }
    ]
}

422

failed processing (after passing validation).

example
HTTP 422
{
    "message": "Subscriber max plan count exceeded",
    "errorCode": 1
}

500

internal error

example
HTTP/1.1 500
{
    "message": "Internal server error - [Failed to get session information]",
    "status": "error"
}

503

request rejected due to overload