GET /api/tenants/{ResourceID}/package
Exports information about business resources on the platform, to a ZIP file. This operation is used internally by the Promotion add-on feature to promote a resource.
Authorization Roles/Permissions: Must have Modify permission for the tenant; for example, a Site Admin.
This topic includes the following sections:
HTTP Method
GET
URL
https://{hostname}/api/tenants/{ResourceID}/package
Sample Request
The example below shows a request to promote the specified resource. Resource information is exported to a ZIP file.
Sample Request URL
https://{hostname}/api/tenants/c6185b9d-e02d-4b14-b41f-749bbc324852.acmepaymentscorp/package
Sample request headers
Accept: application/octet-stream X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
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/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 |
|---|---|---|---|---|
| ResourceID | Path | String | Required |
The ID of the resource that's being exported for promotion. Can be any one of these, and must be valid for the instance of the Community Manager developer portal the operation is being run in: |
Response
If successful, this operation returns HTTP status code 200, with an export ZIP file for the specified resource, which the promotion feature uses.
Sample Response
The sample response below shows successful completion of this operation.
Sample response headers: application/json
Content-Disposition: attachment; filename=apiversion-export.zip Content-Type: application/octet-stream Date: Fri, 05 Oct 2018 21:33:18 GMT
Sample response body: application/json
The response body is the export ZIP file.
In the example below, the operation is run in the browser (after login in a different browser tab) and the download file is returned.
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | application/json, application/octet-stream |
Response Body
The response body is the export ZIP file. The file is named according to the resource being exported:
- API: api-export.zip
- API version: apiversion-export.zip
- App version: appversion-export.zip
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 |
|---|---|
| 400 | Returned if the client sends invalid parameters or body content. For example, you might get this response if you included an invalid ResourceID in the request URL. |
| 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.