class Asana::Resources::OrganizationExport
An organization_export object represents a request to export the complete data of an Organization in JSON format.
To export an Organization using this API:
-
Create an `organization_export` [request](create) and store the id that is returned.\
-
Request the `organization_export` every few minutes, until the `state` field contains 'finished'.\
-
Download the file located at the URL in the `download_url` field.
Exports can take a long time, from several minutes to a few hours for large Organizations.
Note: These endpoints are only available to [Service Accounts](/guide/help/premium/service-accounts) of an [Enterprise](/enterprise) Organization.
Attributes
Public Class Methods
This method creates a request to export an Organization. Asana
will complete the export at some point after you create the request.
organization - [Gid] Globally unique identifier for the workspace or organization.
options - [Hash] the request I/O options. data - [Hash] the attributes to post.
# File lib/asana/resources/organization_export.rb, line 54 def create(client, organization: required("organization"), options: {}, **data) with_params = data.merge(organization: organization).reject { |_,v| v.nil? || Array(v).empty? } Resource.new(parse(client.post("/organization_exports", body: with_params, options: options)).first, client: client) end
Returns details of a previously-requested Organization export.
id - [Gid] Globally unique identifier for the Organization export.
options - [Hash] the request I/O options.
# File lib/asana/resources/organization_export.rb, line 42 def find_by_id(client, id, options: {}) self.new(parse(client.get("/organization_exports/#{id}", options: options)).first, client: client) end
Returns the plural name of the resource.
# File lib/asana/resources/organization_export.rb, line 33 def plural_name 'organization_exports' end