GET /api/licenses/{LicenseID}/package

Exports information about platform licenses to an export file that can be imported to another platform instance.

Authorization Roles/Permissions: Must be logged in. Must have permission to modify the license: Business Admin.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/licenses/{LicenseID}/package

Sample Request

The example below shows a request to export the license information to a download file.

Sample Request URL

https://{hostname}/api/licenses/ee987a07-304b-4f1e-8a88-8dc139f6d300.acmepaymentscorp/package?migration.qospolicy.export=true
&migration.export.include.scopes=true&download=true

Sample request headers

GET http://{hostname}/api/licenses/ee987a07-304b-4f1e-8a88-8dc139f6d300.acmepaymentscorp/package
?migration.qospolicy.export=true&migration.export.include.scopes=true&download=true HTTP/1.0
Host: {hostname}
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json, application/octet-stream
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
LicenseID	Path	string	Required	The unique ID for a specific license.

Response

If successful, this operation returns HTTP status code 200, with the export information in a download file.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Tue, 16 Jun 2015 21:38:07 GMT
Content-Type: application/octet-stream
Content-Disposition: attachment;filename="license-export.zip"

Sample response body

The response body is the export file named in the Content-Disposition header.

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json, application/octet-stream
Content-Disposition	attachment;filename="license-export.zip"

Response Body

The response body is a download file that includes information about the app. The export file is a standard format that can be imported into another instance of the platform for the same tenant. It includes the following files and folders:

• Files:
  • exportproperties.properties
  • objectdata.xml
  • objectgraph.xml
• Folders:
  • content/business/{BusinessID}/legal/{LegalAgreementID/{legal agreement document name}

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics