GET /api/businesses/resources/{ResourceID}/package

Exports information about scopes associated with a business to an export file that can be imported to another platform instance.

Authorization Roles/Permissions: Must have Read permission for the resource. Business Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/businesses/resources/{ResourceID}/package

Back to top

Sample Request

The example below shows a request with all optional parameters included.

Request URL

https://{hostname}/api/businesses/28af4040-32aa-4e8b-9df8-8220d53c7d99.acmepaymentscorp/package

Sample request headers

GET http://{hostname}/api/businesses/resources/28af4040-32aa-4e8b-9df8-8220d53c7d99.acmepaymentscorp/package?&X-Csrf-Token_acmepaymentscorp=TokenID%253Ddcb
719c9-abf2-11e4-ad76-d5be2344e85e%252CexpirationTime%253D1423003830184%252CUserFDN%253D1d473d05-f411-4212-8e4a-c4eeb51b39ba%25252Eacmepaymentscorp%252Csig%25
3DI8k2zpY_rApdWz2iYgG5BjP2Hf69Fs6x5FF4G5AmSBF6AwLBVX_-fcInITqDQ_-awbLt9FPKLhr7X-4ky5R-COLhy69xoYGEmHv-TkIUkD3tnSJKs7_6i1-lyV_bK-JUXtrNO_EYr5ikHtvfx4Klv
DgavjKQCszxIETaTC7kEvU&download=true HTTP/1.0
Host: {hostname}
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
X-Csrf-Token_{tenant}: {TokenID}

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, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

application/octet-stream

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
ResourceID Path string Required The unique ID for a specific resource; for example, the ScopeID or the APIVersionID.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the scope information returned in a file attachment named resource-export.zip.

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

Content-Disposition: attachment;filename="resource-export.zip"
Content-Type: application/octet-stream
Date: Fri, 11 Nov 2016 16:00:59 GMT

Sample response body

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

Back to top

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="resource-export.zip"

Back to top

Response Body

The response body is the export file. Click here to view an example.

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics