Jump to

• Request
• Response

Create usage entitlement using a smart action

post

/crmRestApi/resources/11.13.18.05/subscriptionUsageEntitlements/action/createUsageEntitlement

This method lets you accept rate plan identifier, balance profile identifier and rating model to create usage entitlement with usage entitlement plan and return usage entitlement identifier.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• balanceProfileId: number
  Balance profile identifier for which usage entitlement will be created.
• ratePlanId: number
  Rate plan identifier for which usage entitlement will be created.
• ratingModel: string
  Rating model for which usage entitlement will be created.
• usageEntitlementId: number
  Usage entitlement identifier is an optional parameter.
• usageEntitlementNumber: string
  Usage entitlement number is an optional parameter.

{
    "type":"object",
    "properties":{
        "ratingModel":{
            "type":"string",
            "description":"Rating model for which usage entitlement will be created.",
            "nullable":true
        },
        "ratePlanId":{
            "type":"number",
            "description":"Rate plan identifier for which usage entitlement will be created.",
            "nullable":true
        },
        "usageEntitlementNumber":{
            "type":"string",
            "description":"Usage entitlement number is an optional parameter.",
            "nullable":true
        },
        "balanceProfileId":{
            "type":"number",
            "description":"Balance profile identifier for which usage entitlement will be created.",
            "nullable":true
        },
        "usageEntitlementId":{
            "type":"number",
            "description":"Usage entitlement identifier is an optional parameter.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Response of create usage entitlement using smart action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Response of create usage entitlement using smart action."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Response of create usage entitlement using smart action."
}

Response of create usage entitlement using smart action.

Back to Top