Zuora::EntitiesApi

All URIs are relative to https://rest.zuora.com

Method	HTTP request	Description
delete_entities	DELETE /v1/entities/{id}	Multi-entity: Delete entity
get_entities	GET /v1/entities	Multi-entity: Get entities
get_entity_by_id	GET /v1/entities/{id}	Multi-entity: Get entity by Id
post_entities	POST /v1/entities	Multi-entity: Create entity
put_entities	PUT /v1/entities/{id}	Multi-entity: Update entity
put_provision_entity	PUT /v1/entities/{id}/provision	Multi-entity: Provision entity

delete_entities

DELETEntityResponseType delete_entities(id, opts)

Multi-entity: Delete entity

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Removes an entity and its sub-entities from a multi-entity hierarchy. You can only remove unprovisioned entities. An error occurred when you remove a provisioned entity. ## User Access Permission You must make the call as a global entity administrator.

Example

# load the gem
require 'zuora'

api_instance = Zuora::EntitiesApi.new

id = "id_example" # String | Specify the Id of the entity that you want to delete. You can get the entity Id from the GET Entities call.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Multi-entity: Delete entity
  result = api_instance.delete_entities(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling EntitiesApi->delete_entities: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Specify the Id of the entity that you want to delete. You can get the entity Id from the GET Entities call.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

DELETEntityResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_entities

GETEntitiesResponseType get_entities(opts)

Multi-entity: Get entities

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves detailed information of certain entities in a multi-entity hierarchy. You can retrieve: - Provisioned entities - Unprovisioned entities - Both provisioned and unprovisioned entities ## User Access Permission You can make the call as any entity user.

Example

# load the gem
require 'zuora'

api_instance = Zuora::EntitiesApi.new

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  provisioned: "provisioned_example" # String | Specify whether to retrieve provisioned or unprovisioned entities:  - `true`: Provisioned entities  - `false`: Unprovisioned entities   If you do not specify this field in the request, both the provisioned and unprovisioned entities are returned. 
}

begin
  #Multi-entity: Get entities
  result = api_instance.get_entities(opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling EntitiesApi->get_entities: #{e}"
end

Parameters

Name	Type	Description	Notes
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
provisioned	String	Specify whether to retrieve provisioned or unprovisioned entities: - `true`: Provisioned entities - `false`: Unprovisioned entities If you do not specify this field in the request, both the provisioned and unprovisioned entities are returned.	[optional]

Return type

GETEntitiesResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_entity_by_id

GETEntitiesResponseTypeWithId get_entity_by_id(id, opts)

Multi-entity: Get entity by Id

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves detailed information about a specified entity. ## User Access Permission You can make the call as any entity user.

Example

# load the gem
require 'zuora'

api_instance = Zuora::EntitiesApi.new

id = "id_example" # String | Specify the Id of the entity that you want to retrieve. You can get the entity Id from the GET Entities call.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Multi-entity: Get entity by Id
  result = api_instance.get_entity_by_id(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling EntitiesApi->get_entity_by_id: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Specify the Id of the entity that you want to retrieve. You can get the entity Id from the GET Entities call.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

GETEntitiesResponseTypeWithId

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

post_entities

CreateEntityResponseType post_entities(request, opts)

Multi-entity: Create entity

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates an entity in a multi-entity hierarchy. ## User Access Permission You must make the call as a global entity administrator. ## Notes * We recommend that you assign only one administrator to manage the entity hierarchy, because an administrator of the global entity by default can only access to the entities that are created by themselves.

Example

# load the gem
require 'zuora'

api_instance = Zuora::EntitiesApi.new

request = Zuora::CreateEntityType.new # CreateEntityType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Multi-entity: Create entity
  result = api_instance.post_entities(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling EntitiesApi->post_entities: #{e}"
end

Parameters

Name	Type	Description	Notes
request	CreateEntityType
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

CreateEntityResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

put_entities

UpdateEntityResponseType put_entities(id, request, opts)

Multi-entity: Update entity

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Edits the following information about an unprovisioned entity: - Name - Display name - Locale - Timezone ## User Access Permission You must make the call as a global entity administrator. ## Notes * You are not allowed to edit the locale and time zone of the provisioned entities through the REST API. * You are not allowed to edit the display name of the global entity.

Example

# load the gem
require 'zuora'

api_instance = Zuora::EntitiesApi.new

id = "id_example" # String | The Id of the entity that you want to edit. You can get the entity Id from the GET Entities call.

request = Zuora::UpdateEntityType.new # UpdateEntityType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Multi-entity: Update entity
  result = api_instance.put_entities(id, request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling EntitiesApi->put_entities: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The Id of the entity that you want to edit. You can get the entity Id from the GET Entities call.
request	UpdateEntityType
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

UpdateEntityResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

put_provision_entity

ProvisionEntityResponseType put_provision_entity(id, opts)

Multi-entity: Provision entity

Note: The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Provisions an entity. You can only provision an entity if its parent entity is provisioned. ## User Access Permission You must make the call as a global entity administrator. ## Notes * Zuora does not allow you to remove a provisioned entity from the multi-entity hierarchy. So before you provision an entity, make sure that you put the entity in the correct place in the multi-entity hierarchy.

Example

# load the gem
require 'zuora'

api_instance = Zuora::EntitiesApi.new

id = "id_example" # String | Specify the Id of the entity that you want to provision.  You can get the entity Id from the GET Entities call.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Multi-entity: Provision entity
  result = api_instance.put_provision_entity(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling EntitiesApi->put_provision_entity: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	Specify the Id of the entity that you want to provision. You can get the entity Id from the GET Entities call.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

ProvisionEntityResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

Files

EntitiesApi.md

Latest commit

History

EntitiesApi.md

File metadata and controls

Zuora::EntitiesApi

delete_entities

Example

Parameters

Return type

Authorization

HTTP request headers

get_entities

Example

Parameters

Return type

Authorization

HTTP request headers

get_entity_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

post_entities

Example

Parameters

Return type

Authorization

HTTP request headers

put_entities

Example

Parameters

Return type

Authorization

HTTP request headers

put_provision_entity

Example

Parameters

Return type

Authorization

HTTP request headers