All URIs are relative to https://rest.zuora.com
| Method | HTTP request | Description |
|---|---|---|
| object_delete_unit_of_measure | DELETE /v1/object/unit-of-measure/{id} | CRUD: Delete UnitOfMeasure |
| object_get_unit_of_measure | GET /v1/object/unit-of-measure/{id} | CRUD: Retrieve UnitOfMeasure |
| object_post_unit_of_measure | POST /v1/object/unit-of-measure | CRUD: Create UnitOfMeasure |
| object_put_unit_of_measure | PUT /v1/object/unit-of-measure/{id} | CRUD: Update UnitOfMeasure |
ProxyDeleteResponse object_delete_unit_of_measure(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Delete UnitOfMeasure
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.UnitOfMeasureApi()
id = 'id_example' # str | Object id
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
try:
# CRUD: Delete UnitOfMeasure
api_response = api_instance.object_delete_unit_of_measure(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UnitOfMeasureApi->object_delete_unit_of_measure: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Object id | |
| zuora_entity_ids | str | An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyGetUnitOfMeasure object_get_unit_of_measure(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id, fields=fields)
CRUD: Retrieve UnitOfMeasure
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.UnitOfMeasureApi()
id = 'id_example' # str | Object id
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
fields = 'fields_example' # str | Object fields to return (optional)
try:
# CRUD: Retrieve UnitOfMeasure
api_response = api_instance.object_get_unit_of_measure(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id, fields=fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling UnitOfMeasureApi->object_get_unit_of_measure: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Object id | |
| zuora_entity_ids | str | An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [optional] |
| fields | str | Object fields to return | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyCreateOrModifyResponse object_post_unit_of_measure(create_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Create UnitOfMeasure
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.UnitOfMeasureApi()
create_request = zuora_client.ProxyCreateUnitOfMeasure() # ProxyCreateUnitOfMeasure |
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
try:
# CRUD: Create UnitOfMeasure
api_response = api_instance.object_post_unit_of_measure(create_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UnitOfMeasureApi->object_post_unit_of_measure: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| create_request | ProxyCreateUnitOfMeasure | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ProxyCreateOrModifyResponse object_put_unit_of_measure(id, modify_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Update UnitOfMeasure
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.UnitOfMeasureApi()
id = 'id_example' # str | Object id
modify_request = zuora_client.ProxyModifyUnitOfMeasure() # ProxyModifyUnitOfMeasure |
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
try:
# CRUD: Update UnitOfMeasure
api_response = api_instance.object_put_unit_of_measure(id, modify_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UnitOfMeasureApi->object_put_unit_of_measure: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Object id | |
| modify_request | ProxyModifyUnitOfMeasure | ||
| zuora_entity_ids | str | An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]