TAG LINE
SMALL TITLE
System defined list of levels of sharing that can occur. Such as account level or invoice recipient level.
identity READ-ONLY | "identity": 16 Type: Number This is the unique numeric identifier for the UsageBucketSharePlan |
ownerId READ-ONLY | "ownerId": 9 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
usageBucketShareLevelId | "usageBucketShareLevelId": 17 Type: Number Unique identifier for the associated UsageBucketShareLevel object. |
usageBucketShareLevelName | "usageBucketShareLevelName": "Sample Name" Type: String The name of the object associated with the usageBucketShareLevelId property. |
name | "name": "Gold Plan Bucket" Type: String User defined name for the Share Plan Bucket. |
description | "description": "100MB Inclusion" Type: String User defined description for the Share Plan Bucket. |
usageBucketSharePlanActivationTypeId | "usageBucketSharePlanActivationTypeId": 7 Type: Number Unique identifier for the associated UsageBucketSharePlanActivationType object. |
usageBucketSharePlanActivationTypeName | "usageBucketSharePlanActivationTypeName": "Sample Name" Type: String The name of the object associated with the usageBucketSharePlanActivationTypeId property. |
isActive | "isActive": true Type: Boolean |
isAvailable | "isAvailable": true Type: Boolean |
defaultServiceStatusTypeId | "defaultServiceStatusTypeId": 25 Type: Number Unique identifier for the associated ServiceStatusType object. |
defaultServiceStatusTypeName | "defaultServiceStatusTypeName": "Sample Name" Type: String The name of the object associated with the defaultServiceStatusTypeId property. |
isPackageLevelParticipation | "isPackageLevelParticipation": true Type: Boolean |
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:
DataFlow PATCH objects:
| DELETE | api/v2/Usage/Bucket/SharePlan/{id} |
| Delete an instance of the UsageBucketSharePlan object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageBucketSharePlan object. |
Delete an instance of the UsageBucketSharePlan object. DELETE api/v2/Usage/Bucket/SharePlan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageBucketSharePlan"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/Usage/Bucket/SharePlan/ |
| Retrieve all of the UsageBucketSharePlan objects. | |
Retrieve all of the UsageBucketSharePlan objects. GET api/v2/Usage/Bucket/SharePlan/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 8,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 1,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 14,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 14,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
]
} | |
| GET | api/v2/Usage/Bucket/SharePlan/ForService/{id} |
| Return the UsageBucketSharePlan objects that are related to the specified Service. | |
| {id} | Unique identifier for the Service object. |
Return the UsageBucketSharePlan objects that are related to the specified Service. GET api/v2/Usage/Bucket/SharePlan/ForService/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 26,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 11,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 21,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 4,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
} | |
| GET | api/v2/Usage/Bucket/SharePlan/ForService/{id}/Detail |
| Return the UsageBucketSharePlan object details that are related to the specified Service. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the Service object. |
Return the UsageBucketSharePlan object details that are related to the specified Service. GET api/v2/Usage/Bucket/SharePlan/ForService/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 17,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 19,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 15,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 1,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| GET | api/v2/Usage/Bucket/SharePlan/Paged |
| Retrieve all of the UsageBucketSharePlan objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the UsageBucketSharePlan objects in a paged fashion. GET api/v2/Usage/Bucket/SharePlan/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 14,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 8,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 22,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 4,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
]
}
} | |
| GET | api/v2/Usage/Bucket/SharePlan/Paged/Detail |
| Retrieve all of the UsageBucketSharePlan objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the UsageBucketSharePlan objects in a paged fashion with all object details. GET api/v2/Usage/Bucket/SharePlan/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 0,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 27,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 0,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 14,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v2/Usage/Bucket/SharePlan/{id} |
| Retrieve an instance of the UsageBucketSharePlan object by its ID. | |
| {id} | Unique identifier for the UsageBucketSharePlan object. |
Retrieve an instance of the UsageBucketSharePlan object by its ID. GET api/v2/Usage/Bucket/SharePlan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 18,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 1,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 2,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 3,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
} | |
| GET | api/v2/Usage/Bucket/SharePlan/{id}/Detail |
| Retrieve deep detail of the UsageBucketSharePlan object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageBucketSharePlan object. |
Retrieve deep detail of the UsageBucketSharePlan object by its ID. GET api/v2/Usage/Bucket/SharePlan/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 23,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 2,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 15,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 15,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v2/Usage/Bucket/SharePlan/{id} |
| Update or Add the UsageBucketSharePlan object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the UsageBucketSharePlan object. |
Update or Add the UsageBucketSharePlan object and optionally make changes to any child objects. PATCH api/v2/Usage/Bucket/SharePlan/{id}
{
"details": {},
"usageBucketSharePlans": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"usageBucketShareLevelId": 24,
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 24,
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 5,
"isPackageLevelParticipation": true
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "usageBucketSharePlan",
"instance": {
"identity": 1,
"ownerId": 16,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 25,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 9,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 8,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
}
]
}
} | |
| POST | api/v2/Usage/Bucket/SharePlan/ |
| Create a new instance of the UsageBucketSharePlan object. | |
Create a new instance of the UsageBucketSharePlan object. POST api/v2/Usage/Bucket/SharePlan/
{
"usageBucketShareLevelId": 3,
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 26,
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 2,
"isPackageLevelParticipation": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 12,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 27,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 20,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 20,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
]
}
} | |
| PUT | api/v2/Usage/Bucket/SharePlan/{id} |
| Update an existing instance of the UsageBucketSharePlan object. | |
Update an existing instance of the UsageBucketSharePlan object. PUT api/v2/Usage/Bucket/SharePlan/{id}
{
"identity": 1,
"usageBucketShareLevelId": 6,
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 23,
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 17,
"isPackageLevelParticipation": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 0,
"ownerName": "Sample Text Data",
"usageBucketShareLevelId": 0,
"usageBucketShareLevelName": "Sample Text Data",
"name": "Gold Plan Bucket",
"description": "100MB Inclusion",
"usageBucketSharePlanActivationTypeId": 21,
"usageBucketSharePlanActivationTypeName": "Sample Text Data",
"isActive": true,
"isAvailable": true,
"defaultServiceStatusTypeId": 25,
"defaultServiceStatusTypeName": "Sample Text Data",
"isPackageLevelParticipation": true
}
]
}
} | |