TAG LINE
TAG LINE
SMALL TITLE
Depending Base Bucket this entity allows for specification of Classes or Locations that are either included or excluded from the Base Bucket.
identity READ-ONLY | "identity": 9 Type: Number This is the unique numeric identifier for the UsageBucketBaseDetail |
usageBucketBaseId | "usageBucketBaseId": 1 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": 5 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": 7 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": 19 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. |
| DELETE | Usage/Bucket/BaseDetail/{id} |
| Delete an instance of the UsageBucketBaseDetail object. Upon successful delete, this API will return a record of all of the related 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 Usage/Bucket/BaseDetail/{id}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"
}
]
}
} | |
| GET | Usage/Bucket/BaseDetail/ |
| Retrieve all of the UsageBucketBaseDetail objects. | |
Retrieve all of the UsageBucketBaseDetail objects. GET Usage/Bucket/BaseDetail/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketBaseId": 9,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 20,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 2,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 0,
"geoTreeLocationGroupName": "Sample Text Data"
}
]
} | |
| GET | 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 Usage/Bucket/BaseDetail/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,
"usageBucketBaseId": 13,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 26,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 11,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 0,
"geoTreeLocationGroupName": "Sample Text Data"
}
]
}
} | |
| GET | 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 Usage/Bucket/BaseDetail/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"usageBucketBaseId": 27,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 27,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 0,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 21,
"geoTreeLocationGroupName": "Sample Text Data"
}
} | |
| POST | Usage/Bucket/BaseDetail/ |
| Create a new instance of the UsageBucketBaseDetail object. | |
Create a new instance of the UsageBucketBaseDetail object. POST Usage/Bucket/BaseDetail/
{
"usageBucketBaseId": 12,
"usageClassId": 14,
"geoTreeLocationId": 15,
"exclude": true,
"geoTreeLocationGroupId": 20
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketBaseId": 9,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 6,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 9,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 3,
"geoTreeLocationGroupName": "Sample Text Data"
}
]
}
} | |
| PUT | Usage/Bucket/BaseDetail/{id} |
| Update an existing instance of the UsageBucketBaseDetail object. | |
Update an existing instance of the UsageBucketBaseDetail object. PUT Usage/Bucket/BaseDetail/{id}
{
"identity": 1,
"usageBucketBaseId": 22,
"usageClassId": 12,
"geoTreeLocationId": 6,
"exclude": true,
"geoTreeLocationGroupId": 11
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"usageBucketBaseId": 8,
"usageBucketBaseName": "Sample Text Data",
"usageClassId": 22,
"usageClassName": "Sample Text Data",
"geoTreeLocationId": 17,
"geoTreeLocationName": "Sample Text Data",
"exclude": true,
"geoTreeLocationGroupId": 26,
"geoTreeLocationGroupName": "Sample Text Data"
}
]
}
} | |