GET /api/dropbox/readfiledetails

Accepts a Dropbox ID and ZIP file entry name, and returns a list of APIs/services. If there are multiple files in the ZIP, it returns a list of files so the user can specify one. A resend is then required with the filename. A successful send returns a list of services.

The sequence is:

1. Upload the ZIP file to the Dropbox using the POST /api/dropbox/readfiledetails operation. The response specifies information about the service description that will be used to create the API. If the file uploaded was a ZIP file, the response includes multiple service file names.
2. Choose the service file name from the API response, and use the DropboxID plus the service file name in the current operation, GET /api/dropbox/readfiledetails, to retrieve the name of the service.
3. Use the information in the response to the current operation, to create the API using the POST /api/apis operation.

Authorization Roles/Permissions: Must be logged in. Must be an authorized user for the resource.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/dropbox/readfiledetails

Sample Request

The example below shows the Dropbox ID and specific service to indicate the user's selection for creating the API.

Sample Request URL

https://{hostname}/api/dropbox/readfiledetails?dropboxFileId=1009&zipFileEntry=swagger_petstore.json
?dropboxFileId={dropboxFileId}&zipFileEntry={zipFileEntry}

Sample request headers

GET /api/dropbox/readfiledetails?dropboxFileId=1009&zipFileEntry=swagger_petstore.json HTTP/1.1
Host: {hostname}
Accept: */*
AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...
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/vnd.soa.v71+json
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
dropboxFileId	Query	string	Required	The Dropbox ID of the file previously uploaded to the dropbox.
zipFileEntry	Query	string	Required	Indicates which of the valid service names returned from the ZIP file upload should be used to create the API.

Response

If successful, this operation returns HTTP status code 200, with details about the information that will be used to create the API.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Thu, 02 Aug 2018 16:53:42 GMT
Content-Type: application/json

Sample response body: application/json

{
  "DropboxFileId" : 1009,
  "ServiceDescriptorDocument" : [ {
    "FileName" : "swagger_petstore.json",
    "DescriptorType" : "swagger2",
    "ServiceName" : [ "Swagger_Petstore" ]
  } ]
}

Sample response body shown in Postman

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

Response Body

Name	Type	Description
DropboxFileDetails	DropboxFileDetails	Contains information about file contents that were loaded into the Dropbox.

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