TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 12 Type: Number This is the unique numeric identifier for the UsageBillingType |
ownerId READ-ONLY | "ownerId": 8 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. |
name | "name": "Data" Type: String User defined name for this Billing Type |
number | "number": 16 Type: Number |
usageBillingTypeTypeId | "usageBillingTypeTypeId": 4 Type: Number Unique identifier for the associated UsageBillingTypeType object. |
usageBillingTypeTypeName | "usageBillingTypeTypeName": "Sample Name" Type: String The name of the object associated with the usageBillingTypeTypeId property. |
| DELETE | Usage/BillingType/{id} |
| Delete an instance of the UsageBillingType 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 UsageBillingType object. |
Delete an instance of the UsageBillingType object. DELETE Usage/BillingType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageBillingType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Usage/BillingType/ |
| Retrieve all of the UsageBillingType objects. | |
Retrieve all of the UsageBillingType objects. GET Usage/BillingType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 17,
"ownerName": "Sample Text Data",
"name": "Data",
"number": 17,
"usageBillingTypeTypeId": 15,
"usageBillingTypeTypeName": "Sample Text Data"
}
]
} | |
| GET | Usage/BillingType/Paged |
| Retrieve all of the UsageBillingType 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 UsageBillingType objects in a paged fashion. GET Usage/BillingType/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": 23,
"ownerName": "Sample Text Data",
"name": "Data",
"number": 24,
"usageBillingTypeTypeId": 17,
"usageBillingTypeTypeName": "Sample Text Data"
}
]
}
} | |
| GET | Usage/BillingType/{id} |
| Retrieve an instance of the UsageBillingType object by its ID. | |
| {id} | Unique identifier for the UsageBillingType object. |
Retrieve an instance of the UsageBillingType object by its ID. GET Usage/BillingType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "Data",
"number": 3,
"usageBillingTypeTypeId": 18,
"usageBillingTypeTypeName": "Sample Text Data"
}
} | |
| POST | Usage/BillingType/ |
| Create a new instance of the UsageBillingType object. | |
Create a new instance of the UsageBillingType object. POST Usage/BillingType/
{
"name": "Data",
"number": 5,
"usageBillingTypeTypeId": 14
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "Data",
"number": 7,
"usageBillingTypeTypeId": 27,
"usageBillingTypeTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | Usage/BillingType/{id} |
| Update an existing instance of the UsageBillingType object. | |
Update an existing instance of the UsageBillingType object. PUT Usage/BillingType/{id}
{
"identity": 1,
"name": "Data",
"number": 2,
"usageBillingTypeTypeId": 3
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 10,
"ownerName": "Sample Text Data",
"name": "Data",
"number": 27,
"usageBillingTypeTypeId": 3,
"usageBillingTypeTypeName": "Sample Text Data"
}
]
}
} | |