Usage / Bucket / Share Plan

What can you do with UsageBucketSharePlan?


Properties

Property Details
id
"id": 999
Type: Number
This is the unique numeric identifier for the UsageBucketSharePlan
ownerId
"ownerId": 668
Type: Number
Unique identifier for the associated Owner object.
usageBucketShareLevelId
"usageBucketShareLevelId": 343
Type: Number
Unique identifier for the associated UsageBucketShareLevel object.
name
"name": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
usageBucketSharePlanActivationTypeId
"usageBucketSharePlanActivationTypeId": 451
Type: Number
Unique identifier for the associated UsageBucketSharePlanActivationType object.
isActive
"isActive": true
Type: Boolean
isAvailable
"isAvailable": true
Type: Boolean
defaultServiceStatusTypeId
"defaultServiceStatusTypeId": 712
Type: Number
Unique identifier for the associated ServiceStatusType object.


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:

  • usageBucketShareLevelId
  • name
  • description
  • usageBucketSharePlanActivationTypeId
  • isActive
  • defaultServiceStatusTypeId

DataFlow PATCH objects:


End Points

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