TAG LINE
SMALL TITLE

Usage / Bucket / Share Level

(API Version v4)


System defined list of levels of sharing that can occur. Such as account level or invoice recipient level.


What can you do with UsageBucketShareLevel?


Properties

Property Details
identity
READ-ONLY
"identity": 6
Type: Number
This is the unique numeric identifier for the UsageBucketShareLevel
name
READ-ONLY
"name": "Account"
Type: String
System defined name for the Share Level.
description
READ-ONLY
"description": "Account level"
Type: String
System defined description for the Share Level.


End Points

GETapi/v4/Usage/Bucket/ShareLevel/
Retrieve all of the UsageBucketShareLevel objects.
Retrieve all of the UsageBucketShareLevel objects.
GET api/v4/Usage/Bucket/ShareLevel/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Account",
            "description": "Account level"
        }
    ]
}
GETapi/v4/Usage/Bucket/ShareLevel/Paged
Retrieve all of the UsageBucketShareLevel 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 UsageBucketShareLevel objects in a paged fashion.
GET api/v4/Usage/Bucket/ShareLevel/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,
                "name": "Account",
                "description": "Account level"
            }
        ]
    }
}
GETapi/v4/Usage/Bucket/ShareLevel/{id}
Retrieve an instance of the UsageBucketShareLevel object by its ID.
{id}Unique identifier for the UsageBucketShareLevel object.
Retrieve an instance of the UsageBucketShareLevel object by its ID.
GET api/v4/Usage/Bucket/ShareLevel/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Account",
        "description": "Account level"
    }
}
POSTapi/v4/Usage/Bucket/ShareLevel/Search
Retreive a list of UsageBucketShareLevel objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of UsageBucketShareLevel objects based on search criteria.
POST api/v4/Usage/Bucket/ShareLevel/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Account",
            "description": "Account level"
        }
    ]
}