TAG LINE
SMALL TITLE

Usage / Bucket / Base Detail

(API Version v3)


Depending Base Bucket this entity allows for specification of Classes or Locations that are either included or excluded from the Base Bucket.


What can you do with UsageBucketBaseDetail?


Properties

Property Details
identity
READ-ONLY
"identity": 26
Type: Number
This is the unique numeric identifier for the UsageBucketBaseDetail
usageBucketBaseId
"usageBucketBaseId": 24
Type: Number
Unique identifier for the associated UsageBucketBase object.
usageBucketBaseName
"usageBucketBaseName": "Sample Name"
Type: String
The name of the object associated with the usageBucketBaseId property.
usageClassId
"usageClassId": 0
Type: Number
Unique identifier for the associated UsageClass object.
usageClassName
"usageClassName": "Sample Name"
Type: String
The name of the object associated with the usageClassId property.
geoTreeLocationId
"geoTreeLocationId": 8
Type: Number
Unique identifier for the associated GeoTreeLocation object.
geoTreeLocationName
"geoTreeLocationName": "Sample Name"
Type: String
The name of the object associated with the geoTreeLocationId property.
exclude
"exclude": true
Type: Boolean
Whether or not to exclude the location and/or class specified.
geoTreeLocationGroupId
"geoTreeLocationGroupId": 25
Type: Number
Unique identifier for the associated GeoTreeLocationGroup object.
geoTreeLocationGroupName
"geoTreeLocationGroupName": "Sample Name"
Type: String
The name of the object associated with the geoTreeLocationGroupId property.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • usageBucketBaseId
  • usageClassId
  • geoTreeLocationId
  • exclude
  • geoTreeLocationGroupId

End Points

DELETEapi/v3/Usage/Bucket/BaseDetail/{id}
Delete an instance of the UsageBucketBaseDetail 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 UsageBucketBaseDetail object.
Delete an instance of the UsageBucketBaseDetail object.
DELETE api/v3/Usage/Bucket/BaseDetail/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "usageBucketBaseDetail"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/Usage/Bucket/BaseDetail/
Retrieve all of the UsageBucketBaseDetail objects.
Retrieve all of the UsageBucketBaseDetail objects.
GET api/v3/Usage/Bucket/BaseDetail/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageBucketBaseId": 0,
            "usageBucketBaseName": "Sample Text Data",
            "usageClassId": 0,
            "usageClassName": "Sample Text Data",
            "geoTreeLocationId": 2,
            "geoTreeLocationName": "Sample Text Data",
            "exclude": true,
            "geoTreeLocationGroupId": 25,
            "geoTreeLocationGroupName": "Sample Text Data"
        }
    ]
}
GETapi/v3/Usage/Bucket/BaseDetail/Paged
Retrieve all of the UsageBucketBaseDetail 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 UsageBucketBaseDetail objects in a paged fashion.
GET api/v3/Usage/Bucket/BaseDetail/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketBaseId": 5,
                "usageBucketBaseName": "Sample Text Data",
                "usageClassId": 14,
                "usageClassName": "Sample Text Data",
                "geoTreeLocationId": 25,
                "geoTreeLocationName": "Sample Text Data",
                "exclude": true,
                "geoTreeLocationGroupId": 2,
                "geoTreeLocationGroupName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/Usage/Bucket/BaseDetail/{id}
Retrieve an instance of the UsageBucketBaseDetail object by its ID.
{id}Unique identifier for the UsageBucketBaseDetail object.
Retrieve an instance of the UsageBucketBaseDetail object by its ID.
GET api/v3/Usage/Bucket/BaseDetail/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageBucketBaseId": 25,
        "usageBucketBaseName": "Sample Text Data",
        "usageClassId": 7,
        "usageClassName": "Sample Text Data",
        "geoTreeLocationId": 3,
        "geoTreeLocationName": "Sample Text Data",
        "exclude": true,
        "geoTreeLocationGroupId": 27,
        "geoTreeLocationGroupName": "Sample Text Data"
    }
}
POSTapi/v3/Usage/Bucket/BaseDetail/
Create a new instance of the UsageBucketBaseDetail object.
Create a new instance of the UsageBucketBaseDetail object.
POST api/v3/Usage/Bucket/BaseDetail/

{
    "usageBucketBaseId": 5,
    "usageClassId": 4,
    "geoTreeLocationId": 22,
    "exclude": true,
    "geoTreeLocationGroupId": 15
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketBaseId": 7,
                "usageBucketBaseName": "Sample Text Data",
                "usageClassId": 18,
                "usageClassName": "Sample Text Data",
                "geoTreeLocationId": 26,
                "geoTreeLocationName": "Sample Text Data",
                "exclude": true,
                "geoTreeLocationGroupId": 27,
                "geoTreeLocationGroupName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v3/Usage/Bucket/BaseDetail/{id}
Update an existing instance of the UsageBucketBaseDetail object.
Update an existing instance of the UsageBucketBaseDetail object.
PUT api/v3/Usage/Bucket/BaseDetail/{id}

{
    "identity": 1,
    "usageBucketBaseId": 16,
    "usageClassId": 9,
    "geoTreeLocationId": 20,
    "exclude": true,
    "geoTreeLocationGroupId": 22
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageBucketBaseId": 25,
                "usageBucketBaseName": "Sample Text Data",
                "usageClassId": 14,
                "usageClassName": "Sample Text Data",
                "geoTreeLocationId": 22,
                "geoTreeLocationName": "Sample Text Data",
                "exclude": true,
                "geoTreeLocationGroupId": 23,
                "geoTreeLocationGroupName": "Sample Text Data"
            }
        ]
    }
}