Skip to content

Latest commit

 

History

History
118 lines (78 loc) · 5.79 KB

ExportsApi.md

File metadata and controls

118 lines (78 loc) · 5.79 KB
Raw

Zuora::ExportsApi

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

Method HTTP request Description
object_get_export GET /v1/object/export/{id} CRUD: Retrieve Export
object_post_export POST /v1/object/export CRUD: Create Export

object_get_export

ProxyGetExport object_get_export(id, opts)

CRUD: Retrieve Export

Use this operation to check the status of a data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ExportsApi.new

id = "id_example" # String | Object id

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).
  fields: "fields_example" # String | Object fields to return
}

begin
  #CRUD: Retrieve Export
  result = api_instance.object_get_export(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ExportsApi->object_get_export: #{e}"
end

Parameters

Name Type Description Notes
id String Object id
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]
fields String Object fields to return [optional]

Return type

ProxyGetExport

Authorization

No authorization required

HTTP request headers

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

object_post_export

ProxyCreateOrModifyResponse object_post_export(create_request, opts)

CRUD: Create Export

Use this operation to create a data source export. After you have created a data source export, use CRUD: Retrieve Export to check the status of the data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted.

Example

# load the gem
require 'zuora'

api_instance = Zuora::ExportsApi.new

create_request = Zuora::ProxyCreateExport.new # ProxyCreateExport | 

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
  #CRUD: Create Export
  result = api_instance.object_post_export(create_request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ExportsApi->object_post_export: #{e}"
end

Parameters

Name Type Description Notes
create_request ProxyCreateExport
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

ProxyCreateOrModifyResponse

Authorization

No authorization required

HTTP request headers

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