GET /api/apps/versions/{AppVersionID}/package

Exports the information associated with a specific app version.

Authorization Roles/Permissions: Site Admin, or a user authorized to modify the specific app (an app team member).

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/package?exportVersion=current&migration.app.pki.export=true&migration.export.include.api.connections=true
&migration.export.include.app.team=true&wrapInHTML=true&document.domain={hostname}&download=true

Back to top

Sample Request

The example below shows a request to export the specified app version information to a download file.

Request URL #1

http://acmepaymentscorp/api/apps/versions/6CYql2jSyfK9vaGZrvNkb7Am.acmepaymentscorp/package?
exportVersion=current&wrapInHTML=true&document.domain=acmepaymentscorp

Request URL #2 (all parameters)

http://acmepaymentscorp/api/apps/versions/6CYql2jSyfK9vaGZrvNkb7Am.acmepaymentscorp/package?exportVersion=current&migration.app.pki.export=true
&migration.export.include.api.connections=true&migration.export.include.app.team=true&wrapInHTML=true&document.domain={hostname}&download=true

Sample request headers

GET /api/apps/versions/6CYql2jSyfK9vaGZrvNkb7Am.acmepaymentscorp/package?exportVersion=current
&wrapInHTML=true&document.domain=acmepaymentscorp HTTP/1.1
Host: {hostname}
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

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

Header Description
Accept application/json or application/octet-stream, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.
download Query string Optional If set to true (the default), the content is downloaded. If set to false, the user is prompted for content disposition.
migration.pki.export Query boolean Optional

If specified with value true, include in export file:

  • API Private Key + Certificate (if existing; must be imported via the Policy Manager Console)
migration.app.pki.export Query boolean Optional

If specified with value true, include in export file:

  • App Private Key + Certificate
migration.export.include.api.connections Query boolean Optional

If specified with value true, include in export file:

  • Contracts
migration.export.include.app.team Query boolean Optional

If specified with value true, include in export file:

  • App team members.
    Note: The user's relationship to the app is exported, not the actual user resource; in order for the relationship to be preserved in the target environment, the user must exist in the target environment. If not: a) create and invite the user, b) create the user and re-import the data, or c) invite a different user.

Note:For information about the wrapInHTML parameter shown in the sample request above, see File Upload with Ajax. This is only used if you are running the API in a browser context.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation. The export file is downloaded as specified in the request parameters.

Sample response headers

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Expires: Thu, 25 Sep 2014 16:38:20 GMT
Content-Disposition: attachment;filename="appversion-export.zip"
Content-Encoding: gzip

Sample response body

The response content is sent as the export file named in the Content-Disposition header.

Back to top

Response Headers

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

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

Back to top

Response Body

The response body is a download file that includes information about the app version. 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:

  • exportproperties.properties
  • objectdata.xml
  • objectgraph.xml

Back to top

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.

Back to top

Related Topics