Usage / Bucket / Share Plan

(API Version v2)

What can you do with UsageBucketSharePlan?

DELETE api/v2/Usage/Bucket/SharePlan/{id:int}
GET api/v2/Usage/Bucket/SharePlan
GET api/v2/Usage/Bucket/SharePlan/ForService/{id:int}
GET api/v2/Usage/Bucket/SharePlan/ForService/{id:int}/Detail
GET api/v2/Usage/Bucket/SharePlan/Paged
GET api/v2/Usage/Bucket/SharePlan/Paged/Detail
GET api/v2/Usage/Bucket/SharePlan/{id:int}
GET api/v2/Usage/Bucket/SharePlan/{id:int}/Detail
PATCH api/v2/Usage/Bucket/SharePlan/{id:int}
POST api/v2/Usage/Bucket/SharePlan
PUT api/v2/Usage/Bucket/SharePlan/{id:int}

Properties

Property Details

id	"id": 1 Type: Number This is the unique numeric identifier for the UsageBucketSharePlan
ownerId	"ownerId": 2 Type: Number Unique identifier for the associated Owner object.
usageBucketShareLevelId	"usageBucketShareLevelId": 1 Type: Number Unique identifier for the associated UsageBucketShareLevel object.
name	"name": "Hello World" Type: String
description	"description": "Hello World" Type: String
usageBucketSharePlanActivationTypeId	"usageBucketSharePlanActivationTypeId": 14 Type: Number Unique identifier for the associated UsageBucketSharePlanActivationType object.
isActive	"isActive": true Type: Boolean
isAvailable	"isAvailable": true Type: Boolean
defaultServiceStatusTypeId	"defaultServiceStatusTypeId": 8 Type: Number Unique identifier for the associated ServiceStatusType object.
isPackageLevelParticipation	"isPackageLevelParticipation": 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:

usageBucketShareLevelId
name
description
usageBucketSharePlanActivationTypeId
isActive
defaultServiceStatusTypeId
isPackageLevelParticipation

DataFlow PATCH objects:

usageBucketSharePlan - create, update, delete
usageBucket - create, update, delete
service - attach, detach
serviceType - attach, detach

End Points

DELETE	api/v2/Usage/Bucket/SharePlan/{id:int}
Delete an instance of the UsageBucketSharePlan object.

GET	api/v2/Usage/Bucket/SharePlan
Retrieve all of the UsageBucketSharePlan objects.

GET	api/v2/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.

GET	api/v2/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.

GET	api/v2/Usage/Bucket/SharePlan/Paged
Retreive all of the UsageBucketSharePlan objects in a paged fashion.

GET	api/v2/Usage/Bucket/SharePlan/Paged/Detail
Retreive all of the UsageBucketSharePlan objects in a paged fashion with all object details.

GET	api/v2/Usage/Bucket/SharePlan/{id:int}
Retrieve an instance of the UsageBucketSharePlan object by it's ID.
{id:int}	Unique identifier for the UsageBucketSharePlan object.

GET	api/v2/Usage/Bucket/SharePlan/{id:int}/Detail
Retreive all of the Detail objects for the specified UsageBucketSharePlan.
{id:int}	Unique identifier for the UsageBucketSharePlan object.

PATCH	api/v2/Usage/Bucket/SharePlan/{id:int}
Update the UsageBucketSharePlan object and optionally make changes to any child objects.

POST	api/v2/Usage/Bucket/SharePlan
Create a new instance of the UsageBucketSharePlan object.

PUT	api/v2/Usage/Bucket/SharePlan/{id:int}
Update an existing instance of the UsageBucketSharePlan object.