Alvaria Cloud Media Storage REST API v2.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Overview
The Alvaria™ Cloud Media Storage REST APIs enable developers to retrieve lists of files and folders(object keys) from an Alvaria™ Cloud AWS S3 bucket. Consumers of this API can perform the operations below.
- List object keys
- Get a signed upload url for a file
- Get a signed download url for a file
- Delete a file
Folder Hierarchy
The following shows the structure of the Alvaria™ Cloud S3 bucket import/export folders:
exports
|---configuration
| |----campaign
| |----interaction-management
|---outreach
| |---list-management
|---reporting
| |---enterprise-historical
| |---outreach
| |---intraday
|---reporting-archive
| |---enterprise-historical
| |---outreach
| |---intraday
|--- cxp
| |---recordings
| |---callsre
| |---utterances
|---aps-custom
|---compliance
| |---audit
|---workforce (V3)
|---workflow (V3)
|---motivate
| |---kpi
| |---processed
| |---errors
imports
|---apm
| |----aom
| |----ecf
| | |----processed
| | |----errors
|---configuration
| |----campaign
| |----interaction-management
|---outreach
| |---exclusions
| |---list-management
| |---nanp
|---aps-custom
|---workforce (V3)
|---workflow (V3)
|---motivate
| |---kpi (V3)
| |---processed (V3)
| |---errors (V3)
-
exports:Contains system-generated data used for exporting data from the system. -
exports/reporting/enterprise-historical:Contains Enterprise Data Warehouse (EDW) historical data from the previous day provided in a "tar" format archive file. The data is output in CSV files and is kept for 28 days. Please refer to the Data Extract Manager Model Guide for details on the information that is contained in these CSV files. -
exports/reporting/outreach:Contains data generated from the Outreach component. -
exports/reporting/intraday:Contains hourly raw reporting related data before any transformation.The data is output in CSV files and is kept for 90 days. -
exports/reporting-archive/enterprise-historical:If the unlimited reporting data storage uplift package is enabled the exports/reporting/enterprise-historical data > 90 days old will be transferred here instead of being deleted. -
exports/reporting-archive/outreach:If the unlimited reporting data storage uplift package is enabled the exports/reporting/outreach data > 90 days old will be transferred here instead of being deleted. -
exports/reporting-archive/intraday:If the unlimited reporting data storage uplift package is enabled the exports/reporting/intraday data > 90 days old will be transferred here instead of being deleted. -
exports/configuration/interaction-management:This folder is reserved for future use. -
exports/configuration/campaign:Contains files exported using the Outreach Export/Import feature that allows for exporting and importing configuration data. -
exports/outreach/list-management:Contains Outreach generated uploads. Upload is an Outreach feature that allows for extracting prospect database data to a file for reuse externally or internally. -
exports/aps-custom:Contains data (files) generated from custom applications deployed by Alvaria Professional Services (APS). Data will be kept for 28 days. Please refer to your project related documentation for details on data stored in this folder. -
exports/compliance/audit:Contains error file generated from ComplianceHub during a Load job operation. -
exports/workforce:(V3 Only) Contains user and system generated data exported from Workforce. -
exports/workflow:(V3 Only) Can be used to store data created with Workflow. -
imports:Contains data that is provided from external resources for use by the system. -
imports/apm/aom:Contains imported Performance Management Add On Metrics files that are pending Data Load Job execution. Following a successful Job execution, the file will be removed. An Add On Metrics file should be in the format AOM_yyyy-MM-dd HHmmss.csv -
imports/apm/ecf:Contains imported Performance Management External Contributor Framework files that are pending Data Load Job execution. Following a successful Job execution, the file will be moved to /processed or /errors. For the file format, please refer to the Performance Management System Administrator’s Guide. -
imports/apm/ecf/processed:Contains successfully processed file from a Performance Management External Contributor Framework Data Load Job execution. Following a successful Job execution, the file will be moved to this folder if it was processed successfully. It will be deleted after the configured Days To Keep Import Files of the External Contributor’s Data Instance, or the bucket retention policy, whichever is sooner. For more information, please refer to the Performance Management System Administrator’s Guide. -
imports/apm/ecf/errors:Contains erroneous processed file from a Performance Management External Contributor Framework Data Load Job execution. Following a successful Job execution, the file will be moved to this folder if it could not be processed successfully. It will be deleted after the configured Days To Keep Import Files of the External Contributor’s Data Instance, or the bucket retention policy, whichever is sooner. For more information, please refer to the Performance Management System Administrator’s Guide. -
imports/configuration/interaction-management:This folder is reserved for future use. -
imports/configuration/campaign:Contains the import files that are listed when a user views the list of import files using the Outreach Export/Import feature. -
imports/outreach/list-management:Contains all user input raw files for Outreach. The Outreach UI accessed this folder to get the list of raw files. Outreach also builds strategies from the input files in this folder and updates these raw files after generating an upload. -
imports/outreach/exclusions:Contains all exclusions and convenient time to call data files. The Outreach UI accesses this folder when loading exclusion and convenient time to call input files. -
imports/outreach/nanp:This folder is reserved for future use. -
imports/aps-custom:Contains data (files) to be imported by custom applications deployed by Alvaria Professional Services (APS). Data will be kept for 28 days. Please refer to your project related documentation for details on data stored in this folder. -
imports/workforce:(V3 Only) Contains data that is provided from external resources for importing into Workforce. -
imports/workflow:(V3 Only) Contains data to be processed with Workflow. -
imports/motivate/kpi:(V3 Only) Contains imported Motivate KPI Import Manager files that are pending import job execution. Following a successful import job execution, the file will be moved to /processed or /errors. For the file format, please refer to the Motivate System Administrator’s Guide. -
imports/motivate/kpi/processed:(V3 Only) Contains successfully processed file from a Motivate KPI Import Manager import job execution. Following a successful import job execution, the file will be moved to this folder if it was processed successfully. It will be deleted after the bucket retention policy. For more information, please refer to the Motivate System Administrator’s Guide. -
imports/motivate/kpi/errors:(V3 Only) Contains erroneous processed files from a Motivate KPI Import Manager import job execution. Following a successful import job execution, the file will be moved to this folder if it could not be processed successfully. It will be deleted after the bucket retention policy. For more information, please refer to the Motivate System Administrator’s Guide..
Scopes
Security for above folders is driven by the following scopes. Please procure your client credentials with these scopes depending on the specific folders you will upload files to or download files from using the API.
mediastorageapi.exports- to download files from folders in the exports folder hierarchy.mediastorageapi.imports- to upload files to folders in the imports folder hierarchy.
Downloading Files From The Alvaria™ Cloud S3 Bucket
Downloading files from the Alvaria™ Cloud S3 bucket is a two step process:
- Acquire a signed download URL for the file using the /mediaStorage/data/objectKeys API endpoint as shown in the following example where the file outreach-20180401.tar needs to be downloaded from the exports/reporting/outreach folder:
curl -X GET "https://{orgId}.via.aspect-cloud.net/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=exports%2Freporting%2Foutreach%2foutreach-20180401.tar&keyType=signedDownloadUrl"
The response will contain a secure, signed URL for accessing the required file in storage. The signed URL will expire in one hour. Below are example responses:
Amazon:
{
"key": "exports/reporting/outreach/outreach-20180401.tar",
"keyHash": "1a011762cec01ce9051c0eb81fc6f766",
"keyName": "outreach-20180401.tar",
"size": "5370.0 KB",
"lastModifiedTime": "2018-04-30T19:11:56Z",
"keyType": "File ",
"signedUploadUrl": " ",
"signedDownloadUrl": "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId].s3.amazonaws.com/exports/outreach/outre ach-20180401.tar?X-Amz-Security-Token=FQoDYXdzE%2F0W6e7L4hIp8cTCmWdPZ0IBOaT3w%2B5UiVKMDdrNcF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180503T164001Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAI2647DEKRJOGMUMA%2F20180503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=15d827ba81597255b71c4493472ef132adccbbe5270da7bddc95c92451d90c75",
"nativeSignedDownloadUrl": "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId].s3.amazonaws.com/exports/outreach/outre ach-20180401.tar?X-Amz-Security-Token=FQoDYXdz2F0W6e7L4hIp8cTCmWdPZ0IBOaT3w%2B5UiVKMDdrNcF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180503T164001Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAI2647DEKRJOGMUMA%2F20180503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=15d827ba81597255b71c4493472ef132adccbbe5270da7bddc95c92451d90c75"
}
Google:
{
"key": "exports/reporting/outreach/outreach-20180401.tar",
"keyHash": "1a011762cec01ce9051c0eb81fc6f766",
"keyName": "outreach-20180401.tar",
"size": "5370.0 KB",
"lastModifiedTime": "2018-04-30T19:11:56Z",
"keyType": "File ",
"signedUploadUrl": " ",
"signedDownloadUrl": "https://orgId.adc.alvaria.cloud/gcs/storage.googleapis.com/adc-bnw-data-raptors/outreach-20180401.tar?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=bnw-bklyn-raptors-an2c.iam.gserviceaccount.com%2F20230321%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20230321T023028Z&X-Goog-Expires=21599&X-Goog-SignedHeaders=host&X-Goog-Signature=62d0f70ca3f03ff1a3b17e883c25750478f5b0af555e956610e31807a63e3e53ebd577a50ea885d4e27d",
"nativeSignedDownloadUrl": "https://storage.googleapis.com/adc-bnw-data-orgId/outreach-20180401.tar?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=bnw-bklyn-raptors-an2c.iam.gserviceaccount.com%2F20230321%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20230321T023028Z&X-Goog-Expires=21599&X-Goog-SignedHeaders=host&X-Goog-Signature=62d0f70ca3f03ff1a3b17e883c25750478f5b0af555e956610e31807a63e3e53ebd577a50ea885d4e27d41c2e165c6977a1a178495e473d76d21a6b77d59fe652834f4be993ee8be44e53f05920dda25e896a1e"
}
- Use the signed download url URL to download the a file as shown in the following example (Amazon)
curl -X GET "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId].s3.amazonaws.com/exports/reporting/outreach/outreach-20180401.tar?X-Amz-Security-Token=FQoDYXdzB5UiVKMDdrNcF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180503T164001Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAI2647DEKRJOGMUMA%2F20180503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=15d827ba81597255b71c4493472ef132adccbbe5270da7bddc95c92451d90c75"
Uploading Files To The Alvaria™ Cloud S3 Bucket
Uploading files to the Alvaria™ Cloud S3 bucket is a two step process:
- Acquire a signed upload URL for the file using the /mediaStorage/data/objectKeys API endpoint as shown in the following example where the file outreach.raw needs to be uploaded to the imports/outreach/list-management folder:
curl -X GET "https://{orgId}.via.aspect-cloud.net/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=imports%2Foutreach%2flist-management%2foutreach.raw&keyType=signedUploadUrl"
The response will contain a secure, signed URL for placing the required file in S3. The signed URL will expire in one hour. Below is an example of a response:
{
"key": "imports/outreach/list-management/outreach.raw",
"keyHash": "d926d7bb9ccf46fc04a61bd65d87b9b3",
"keyName": "outreach.raw",
"size": "",
"lastModifiedDate": "",
"keyType": "File",
"signedUploadUrl": "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId}.s3.amazonaws.com/imports/outreach/list-management/outreach.raw?kms-key=08e98aa8-1c0a-4547-bf34-e6f6aa11d16a&x-amz-storage-class=STANDARD_IA&X-Amz-Secur ity-Token=FQoDYXdzEEkaDNf1hxLJ2DFLxBjBbiL7AbDVwBqRx2QaKTtnoBxmYLaR%2BEHQF3og1ByQvn61nPa1ZYjlsiWF3ZGWJmalP5hrbdc%2FmTJjnIKN2ZsLS9%2Fj%2FSRlIyYZAK1FwL0CXozD3WtEORkNR0OP5nx2L%2Bh%2BLmKIHCsC3Bm7DVjnt%2FR%2B4az6wJ8NKZwwX7uylxhEu3uja2nRiNjD0XSiDLlfUkHlUBS597pKPqcH4qNmDmqszFIIoxbXuR6Se%2BLtj0W Qq5era5ruk%2Fp0QrNwuuVIM6w%2FWmhk5N3Ld1GNl5ndvZbxQ%2FUVp1y5L%2FRiKsOqg7wjNO5beT52QPZ%2F0W6e7L4hIp8cTCmWdPZ0IBOaT3w%2B5UiVKMDdrNcF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180503T164435Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id&X-Amz-Expires=518399&X-Amz-Credential=ASIAI2647DEKRJOGMUMA%2F20180503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6fff00bbccc8202169412ae68c7995a69aa03a49114ca8e5bb6eb97f516d1741",
"nativeSignedUploadUrl": "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId}.s3.amazonaws.com/imports/outreach/list-management/outreach.raw?kms-key=08e98aa8-1c0a-4547-bf34-e6f6aa11d16a&x-amz-storage-class=STANDARD_IA&X-Amz-Secur ity-Token=FQoDYXdzEEkaDNf1hxLJ2DFLxBjBbiL7AbDVwBqRx2QaKTtnoBxmYLaR%2BEHQF3og1ByQvn61nPa1ZYjlsiWF3ZGWJmalP5hrbdc%2FmTJjnIKN2ZsLS9%2Fj%2FSRlIyYZAK1FwL0CXozD3WtEORkNR0OP5nx2L%2Bh%2BLmKIHCsC3Bm7DVjnt%2FR%2B4az6wJ8NKZwwX7uylxhEu3uja2nRiNjD0XSiDLlfUkHlUBS597pKPqcH4qNmDmqszFIIoxbXuR6Se%2BLtj0W Qq5era5ruk%2Fp0QrNwuuVIM6w%2FWmhk5N3Ld1GNl5ndvZbxQ%2FUVp1y5L%2FRiKsOqg7wjNO5beT52QPZ%2F0W6e7L4hIp8cTCmWdPZ0IBOaT3w%2B5UiVKMDdrNcF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180503T164435Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id&X-Amz-Expires=518399&X-Amz-Credential=ASIAI2647DEKRJOGMUMA%2F20180503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6fff00bbccc8202169412ae68c7995a69aa03a49114ca8e5bb6eb97f516d1741",
"signedDownloadUrl": ""
}
- Use the signed upload URL to upload a file by sending an HTTP "PUT" request using the signed upload URL as shown in the following example:
curl -X PUT "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId}.s3.amazonaws.com/imports/outreach/list-management/outreach.raw?kms-key=08e98aa8-1c0a-4547-bf34-e6f6aa11d16a&x-amz-storage-class=STANDARD_IA&X-Amz-Security-Token=FQoDYXdzEEkaDNf1hxLJ2DFLxBjBbiL7AbDVwBqRx2QaKTtnoBxmYLaR%2BEHQF3og1ByQvn61nPa1ZYjlsiWF3ZGWJmalP5hrbdc%2FmTJjnIKN2ZsLS9%2Fj%2FSRlIyYZAK1FwL0CXozD3WtEORkNR0OP5nx2L%2Bh%2BLmKIHCsC3Bm7DVjnt%2FR%2B4az6wJ8NKZwwX7uylxhEu3uja2nRiNjD0XSiDLlfUkHlUBS597pKPqcH4qNmDmqszFIIoxbXuR6Se%2BLtj0W Qq5era5ruk%2Fp0QrNwuuVIM6w%2FWmhk5N3Ld1GNl5ndvZbxQ%2FUVp1y5L%2FRiKsOqg7wjNO5beT52QPZ%2F0W6e7L4hIp8cTCmWdPZ0IBOaT3w%2B5UiVKMDdrNcF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180503T164435 Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id&X-Amz-Expires=518399&X-Amz-Credential=ASIAI2647DEKRJOGMUMA%2F20180503%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6fff00bbccc8202169412ae68c7995a69aa03a49114ca8e5bb6eb97f516d1741" \
-H "x-amz-server-side-encryption:'aws:kms'" \
-H "x-amz-server-side-encryption-aws-kms-key-id={kmsId}"
where kmsId can be retrieved from the query parameter kms-key in the signed upload URL as shown below:
"signedUploadUrl": "https://{orgId}.via.aspect-cloud.net/s3/aspect-via-data-{region}-{orgId}.s3.amazonaws.com/imports/outreach/list-management/outreach.raw?kms-key=08e98aa8-1c0a-4547-bf34-e6f6aa11d16a"
Please refer to these sites for more information on uploading objects using pre signed urls.
- https://docs.aws.amazon.com/AmazonS3/latest/dev/PresignedUrlUploadObject.html
- https://cloud.google.com/storage/docs/access-control/signed-urls
Note: domain in the base URL corresponds to the Alvaria™ website that hosts the API. Presently, it differs by cloud vendor.
| Cloud Vendor | Domain | |
|---|---|---|
| AWS (Amazon Web Services), Microsoft Azure | via.aspect-cloud.net | |
| GCP (Google Cloud Platform) | apc.alvaria.cloud |
Base URLs:
License: License: Creative Commons Attribution 4.0 International Public License
Authentication
-
oAuth2 authentication.
- Flow: client crendentials
- Authorization URL = https://myaspect.{region}.id.aspect-cloud.net/tokenservice/oauth2/access_token
| Scope | Scope Description |
|---|---|
| mediastorageapi.exports | Manage S3 resources |
| mediastorageapi.exports.reporting | Manage S3 resources |
| mediastorageapi.exports.reporting.historical | Manage S3 resources |
| mediastorageapi.exports.reporting.outreach | Manage S3 resources |
| mediastorageapi.exports.configuration | Manage S3 resources |
| mediastorageapi.exports.configuration.interaction | Manage S3 resources |
| mediastorageapi.exports.configuration.campaign | Manage S3 resources |
| mediastorageapi.exports.outreach | Manage S3 resources |
| mediastorageapi.exports.outreach.list | Manage S3 resources |
| mediastorageapi.exports.cxp | Manage S3 resources |
| mediastorageapi.exports.cxp.callsre | Manage S3 resources |
| mediastorageapi.exports.cxp.recordings | Manage S3 resources |
| mediastorageapi.exports.cxp.utterances | Manage S3 resources |
| mediastorageapi.exports.aps-custom | Manage S3 resources |
| mediastorageapi.exports.compliance | Manage S3 resources |
| mediastorageapi.exports.compliance.audit | Manage S3 resources |
| mediastorageapi.exports.workforce | Manage S3 resources |
| mediastorageapi.exports.workflow | Manage S3 resources |
| mediastorageapi.imports | Manage S3 resources |
| mediastorageapi.imports.apm | Manage S3 resources |
| mediastorageapi.imports.apm.aom | Manage S3 resources |
| mediastorageapi.imports.apm.ecf | Manage S3 resources |
| mediastorageapi.imports.apm.ecf.processed | Manage S3 resources |
| mediastorageapi.imports.apm.ecf.errors | Manage S3 resources |
| mediastorageapi.imports.configuration | Manage S3 resources |
| mediastorageapi.imports.configuration.interaction | Manage S3 resources |
| mediastorageapi.imports.configuration.campaign | Manage S3 resources |
| mediastorageapi.imports.outreach | Manage S3 resources |
| mediastorageapi.imports.outreach.list | Manage S3 resources |
| mediastorageapi.imports.outreach.exclusions | Manage S3 resources |
| mediastorageapi.imports.outreach.nanp | Manage S3 resources |
| mediastorageapi.imports.aps-custom | Manage S3 resources |
| mediastorageapi.imports.workforce | Manage S3 resources |
| mediastorageapi.imports.workflow | Manage S3 resources |
| mediastorageapi.imports.motivate | Manage S3 resources |
| mediastorageapi.imports.motivate.kpi | Manage S3 resources |
| mediastorageapi.imports.motivate.kpi.processed | Manage S3 resources |
| mediastorageapi.imports.motivate.kpi.errors | Manage S3 resources |
ObjectKeys
Retrieves list of object keys from S3 bucket
Code samples
# You can also use wget
curl -X GET https://orgId.domain/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=string&keyType=file \
-H 'Accept: application/json' \
-H 'Authorization: string' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-api-key':'string'
};
fetch('https://orgId.domain/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=string&keyType=file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.domain/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=string&keyType=file HTTP/1.1
Host: orgid.domain
Accept: application/json
Authorization: string
x-api-key: string
GET /via/v2/organizations/{orgId}/mediaStorage/data/objectKeys
This operation retrieves a list of object keys from an S3 bucket, which you can filter using query parameters To return a list of directories inhierarchical format, use the query parameter objectKeysType=directory. To return a list of files from all the child folders, use the query parameter objectKeysType=file. To get a signed upload URL, use signedUrlType parameter=upload, and to get a signed download URL, use signedUrlType=download.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| key | query | string | true | Complete path to the object key. If the key is a folder, the path to the object ends with '/'. If the key is a file name, then it is a path to the file name. |
| keyType | query | string | true | Type of object keys to retrieve from the bucket. Use the following query parameters: |
| maxResults | query | integer | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. |
| continuationToken | query | string | false | An opaque value that Amazon S3 understands. Amazon S3 lists objects in UTF-8 character encoding in lexicographical order. |
| orgId | path | string | true | Name of a customer organization |
Detailed descriptions
x-api-key: Alvaria-provided value used to track API endpoint usage
keyType: Type of object keys to retrieve from the bucket. Use the following query parameters: file: Retrieves a list of files under the specified folder(key). This list includes all the files in all the subfolders as a flat structure. directory: Retrieves a list of directories in hierarchical format, including the top level key. file:directory:Retreives a list of files and folders one level below. signedUploadUrl: Returns a signed upload URL for the specified object key. signedDownloadUrl: Returns a signed download URL for the specified key.
Enumerated Values
| Parameter | Value |
|---|---|
| keyType | file |
| keyType | directory |
| keyType | signedUploadUrl |
| keyType | signedDownloadUrl |
| keyType | nativeSignedUploadUrl |
| keyType | nativeSignedDownloadUrl |
Example responses
200 Response
{
"kind": "objectKeys",
"continuationToken": "1r9Wr8kyEUJAyKZSaCPKqGB7I82fcNaLn7cekXJMgaou/XC44lh65A5Lh/bx34mWFrqZk/+J%2B6wXNFaDeGbbjEnjE4rx2br40gf2Y6XUXKmQ=",
"objectKeys": [
{
"kind": "objectKey",
"key": "data-extracts/",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [
{}
],
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response. Based on the query parameters supplied, the response is different. Use query parameter objectKeys Type=directory to return a list of directories in hierarchical format. Use query parameter objectKeys type=file to return list of files from all child folders. Use signedUrlType parameter=upload to get a signed upload URL and signedUrlType=download to get signed download URL. | ObjectKeysResponse |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | No record exists for the provided key | Error |
| 405 | Method Not Allowed | Method Not Allowed | Error |
| 429 | Too Many Requests | Throttled | Error |
| 500 | Internal Server Error | Internal server error | Error |
Deletes an object key from an S3 bucket
Code samples
# You can also use wget
curl -X DELETE https://orgId.domain/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=string \
-H 'Accept: application/json' \
-H 'Authorization: string' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-api-key':'string'
};
fetch('https://orgId.domain/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=string',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE https://orgId.domain/via/v2/organizations/{orgId}/mediaStorage/data/objectKeys?key=string HTTP/1.1
Host: orgid.domain
Accept: application/json
Authorization: string
x-api-key: string
DELETE /via/v2/organizations/{orgId}/mediaStorage/data/objectKeys
Deletes an object key from an S3 bucket
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| key | query | string | true | Complete path to the object key. If the key is a folder, the path to the object ends with '/'. If the key is a file name, then it is a path to the file name. |
| orgId | path | string | true | Name of a customer organization |
Detailed descriptions
x-api-key: Alvaria-provided value used to track API endpoint usage
Example responses
400 Response
{
"error": {
"code": "400",
"message": "Bad request",
"errors": [
{
"scope": "global",
"reason": "Invalid request",
"message": "The bucketName is invalid"
}
]
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successful response | None |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | No record exists for the provided key | Error |
| 405 | Method Not Allowed | Method Not Allowed | Error |
| 429 | Too Many Requests | Throttled | Error |
| 500 | Internal Server Error | Internal server error | Error |
Retrieves a list of object keys from cloud storage bucket
Code samples
# You can also use wget
curl -X GET https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/objectKeys?key=string&keyType=file \
-H 'Accept: application/json' \
-H 'Authorization: string' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-api-key':'string'
};
fetch('https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/objectKeys?key=string&keyType=file',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/objectKeys?key=string&keyType=file HTTP/1.1
Host: orgid.domain
Accept: application/json
Authorization: string
x-api-key: string
GET /via/v3/organizations/{orgId}/mediaStorage/data/objectKeys
Retrieves a list of object keys from cloud storage bucket.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| key | query | string | true | Complete path to the object key. If the key is a folder, the path to the object ends with '/'. If the key is a file name, then it is a path to the file name. |
| keyType | query | string | true | Type of object keys to retrieve from the bucket. Use the following query parameters: |
| maxResults | query | integer | false | Maximum results. This is used to specify the maximum number of records to return in the result set. You can use this to set a result set limit that is less than the system/API-specific limit. |
| nextToken | query | string | false | Specifies the token of the first object key from which the result set should start. This value is provided by the nextToken field in the response from a previous request to this endpoint. |
| orgId | path | string | true | Name of a customer organization |
Detailed descriptions
x-api-key: Alvaria-provided value used to track API endpoint usage
keyType: Type of object keys to retrieve from the bucket. Use the following query parameters: file: Retrieves a list of files under the specified folder(key). This list includes all the files in all the subfolders as a flat structure. directory: Retrieves a list of directories in hierarchical format, including the top level key. file:directory:Retreives a list of files and folders one level below.
Enumerated Values
| Parameter | Value |
|---|---|
| keyType | file |
| keyType | directory |
Example responses
200 Response
{
"kind": "objectKeys",
"nextToken": "ZXhwb3J0cy9yZXBvcnRpbmcvaW50cmFkYXkvaW50cmFkYXktMjAyMV8wNV8zMV8xNC50YXIuZ3o=",
"totalItems": "500",
"objectKeys": [
{
"kind": "objectKey",
"key": "data-extracts/",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [
{}
],
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response. Based on the query parameters supplied, the response is different. Use query parameter objectKeys Type=directory to return a list of directories in hierarchical format. Use query parameter objectKeys type=file to return list of files from all child folders. | ObjectKeysResponseV3 |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | No record exists for the provided key | Error |
| 405 | Method Not Allowed | Method Not Allowed | Error |
| 429 | Too Many Requests | Throttled | Error |
| 500 | Internal Server Error | Internal server error | Error |
Deletes an object key from an Storage bucket
Code samples
# You can also use wget
curl -X DELETE https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/objectKeys?key=string \
-H 'Accept: application/json' \
-H 'Authorization: string' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-api-key':'string'
};
fetch('https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/objectKeys?key=string',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
DELETE https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/objectKeys?key=string HTTP/1.1
Host: orgid.domain
Accept: application/json
Authorization: string
x-api-key: string
DELETE /via/v3/organizations/{orgId}/mediaStorage/data/objectKeys
Deletes an object key from an Storage bucket
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| key | query | string | true | Complete path to the object key. If the key is a folder, the path to the object ends with '/'. If the key is a file name, then it is a path to the file name. |
| orgId | path | string | true | Name of a customer organization |
Detailed descriptions
x-api-key: Alvaria-provided value used to track API endpoint usage
Example responses
200 Response
{
"key": "imports/outreach/list-management/outreach.raw",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"status": "Delete request succeeded"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response | ObjectDeleteResponse |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | No record exists for the provided key | Error |
| 405 | Method Not Allowed | Method Not Allowed | Error |
| 429 | Too Many Requests | Throttled | Error |
| 500 | Internal Server Error | Internal server error | Error |
Signed URLs
Retrieves SignedUploadUrl of object key from Storage bucket
Code samples
# You can also use wget
curl -X GET https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/signedUploadUrl?key=string \
-H 'Accept: application/json' \
-H 'Authorization: string' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-api-key':'string'
};
fetch('https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/signedUploadUrl?key=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/signedUploadUrl?key=string HTTP/1.1
Host: orgid.domain
Accept: application/json
Authorization: string
x-api-key: string
GET /via/v3/organizations/{orgId}/mediaStorage/data/signedUploadUrl
This operation retrieves a signed upload URL for the specified object key, which you can use for uploading the object to the storage bucket.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| key | query | string | true | This operation retrieves a signed upload URL for the specified object key, which you can use for uploading the object to the storage bucket.. |
| orgId | path | string | true | Name of a customer organization |
Detailed descriptions
x-api-key: Alvaria-provided value used to track API endpoint usage
Example responses
200 Response
{
"key": "data-extracts/",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response with a signedUploadUrl details. | SignedUploadUrlResponse |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | No record exists for the provided key | Error |
| 405 | Method Not Allowed | Method Not Allowed | Error |
| 429 | Too Many Requests | Throttled | Error |
| 500 | Internal Server Error | Internal server error | Error |
Retrieves SignedDownloadUrl of object key from Storage bucket
Code samples
# You can also use wget
curl -X GET https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/signedDownloadUrl?key=string \
-H 'Accept: application/json' \
-H 'Authorization: string' \
-H 'x-api-key: string'
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'Authorization':'string',
'x-api-key':'string'
};
fetch('https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/signedDownloadUrl?key=string',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
GET https://orgId.domain/via/v3/organizations/{orgId}/mediaStorage/data/signedDownloadUrl?key=string HTTP/1.1
Host: orgid.domain
Accept: application/json
Authorization: string
x-api-key: string
GET /via/v3/organizations/{orgId}/mediaStorage/data/signedDownloadUrl
This operation retrieves a signed download URL for the specified object key, which you can use for downloading the object from Storage bucket.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Authentication token with the value: 'Bearer {accessToken}', where {accessToken} was returned from a call to the authorization endpoint |
| x-api-key | header | string | true | Alvaria-provided value used to track API endpoint usage |
| key | query | string | true | This operation retrieves a signed download URL for the specified object key, which you can use for downloading the object from Storage bucket. |
| orgId | path | string | true | Name of a customer organization |
Detailed descriptions
x-api-key: Alvaria-provided value used to track API endpoint usage
Example responses
200 Response
{
"key": "data-extracts/",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successful response with a signedDownloadUrl details. | SignedDownloadUrlResponse |
| 400 | Bad Request | Bad Request | Error |
| 401 | Unauthorized | Unauthorized | None |
| 404 | Not Found | No record exists for the provided key | Error |
| 405 | Method Not Allowed | Method Not Allowed | Error |
| 429 | Too Many Requests | Throttled | Error |
| 500 | Internal Server Error | Internal server error | Error |
Schemas
ObjectKeysFragment
{
"kind": "objectKey",
"key": "data-extracts/",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [
{
"kind": "objectKey",
"key": "data-extracts/",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [],
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
],
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
ObjectKeysFragment
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| key | boolean | false | none | Path to the object key |
| keyName | string | false | none | Object key name |
| size | string | false | none | Size of the object key in kilobytes. This is applicable for the file type object key only. |
| lastModifiedTime | string(date-time) | false | none | Last modified date for the object key |
| keyType | string | false | none | Type of file, which is File or Directory |
| childObjectKeys | [ObjectKeysFragment] | false | none | Sub-directories inside an object key |
| signedUploadUrl | string | false | none | Signed upload URL for the object key. This value is used for the signedUploadUrl request keyType only.Signed upload URL expires after an hour. |
| nativeSignedUploadUrl | string | false | none | Native Signed upload URL for the object key. This value is used for the nativeSignedUploadUrl request keyType only. Native Signed upload URL expires after an hour. |
| signedDownloadUrl | string | false | none | Signed download URL for the object key. This value is used for the signedDownloadUrl keyType only.Signed download URL expires after an hour |
| nativeSignedDownloadUrl | string | false | none | Native Signed download URL for the object key. This value is used for the nativeSignedDownloadUrl request keyType only. Native Signed download URL expires after an hour |
Enumerated Values
| Property | Value |
|---|---|
| keyType | file |
| keyType | directory |
ObjectDeleteResponse
{
"key": "imports/outreach/list-management/outreach.raw",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"status": "Delete request succeeded"
}
ObjectDeleteResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | boolean | false | none | Path to the object key |
| keyHash | string | false | none | Object key name |
| status | string | false | none | Size of the object key in kilobytes. This is applicable for the file type object key only. |
ObjectKeysResponse
{
"kind": "objectKeys",
"continuationToken": "1r9Wr8kyEUJAyKZSaCPKqGB7I82fcNaLn7cekXJMgaou/XC44lh65A5Lh/bx34mWFrqZk/+J%2B6wXNFaDeGbbjEnjE4rx2br40gf2Y6XUXKmQ=",
"objectKeys": [
{
"kind": "objectKey",
"key": "data-extracts/",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [
{}
],
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results |
| continuationToken | string | false | none | An opaque value that Amazon S3 understands. Amazon S3 lists objects in UTF-8 character encoding in lexicographical order. |
| objectKeys | [ObjectKeysFragment] | false | none | none |
SignedUploadUrlResponse
{
"key": "data-extracts/",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
SignedUploadUrlResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | boolean | false | none | Path to the object key |
| keyHash | string | false | none | Object key name |
| keyName | string | false | none | Object key name |
| size | string | false | none | Size of the object key in kilobytes. This is applicable for the file type object key only. |
| lastModifiedTime | string(date-time) | false | none | Last modified date for the object key |
| signedUploadUrl | string | false | none | Signed upload URL for the object key. This value is used for the signedUploadUrl request only. Signed upload URL expires after an hour. |
| nativeSignedUploadUrl | string | false | none | Native Signed upload URL for the object key. This value is used for the nativeSignedUploadUrl request only. Native Signed upload URL expires after an hour. |
SignedDownloadUrlResponse
{
"key": "data-extracts/",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
SignedDownloadUrlResponse
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | boolean | false | none | Path to the object key |
| keyHash | string | false | none | Object key name |
| keyName | string | false | none | Object key name |
| size | string | false | none | Size of the object key in kilobytes. This is applicable for the file type object key only. |
| lastModifiedTime | string(date-time) | false | none | Last modified date for the object key |
| signedDownloadUrl | string | false | none | Signed download URL for the object key. This value is used for the signedDownloadUrl only. Signed download URL expires after an hour |
| nativeSignedDownloadUrl | string | false | none | Native Signed download URL for the object key. This value is used for the nativeSignedDownloadUrl request only. Native Signed download URL expires after an hour |
ObjectKeysResponseV3
{
"kind": "objectKeys",
"nextToken": "ZXhwb3J0cy9yZXBvcnRpbmcvaW50cmFkYXkvaW50cmFkYXktMjAyMV8wNV8zMV8xNC50YXIuZ3o=",
"totalItems": "500",
"objectKeys": [
{
"kind": "objectKey",
"key": "data-extracts/",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [
{}
],
"signedUploadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedUploadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"signedDownloadUrl": "https://test.via.aspect-cloud.net/s3/aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f",
"nativeSignedDownloadUrl": "https://aspect-via-pvd-common.s3.amazonaws.com/cxp/cork/Audio/Messages/hours.wav?X-Amz-Security-Token=FQoDYXdzEJn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDNXqwahT0%2BCL8wxFyiL1Ac5qEeE6UEgzfKgwRM%2FJKbuD4HqH9n75FGQB7GjoFmaxup2C7beu4YfLQsZ6nWo8KVL%2BwId4UuNEc8Mk6uVUlm58TEx4rwgSsnFatrDacdMQDwy760DH5RIJQdgrrsRrk4AU2e7YW5iBprpATQ45LKooZTGKEFOf9GS%2Bufru005LR%2BQ91m8TT8S3DvFuiha0J8p16QjMblpJMGfaxCh%2FatxW9i7szwKVURI%2FOpDMcgs%2BM3%2B5%2BdA4cZZ2p0Ci2LxQdDf9cUJ2ZR2zXWWTJ%2FB64SuYje8ZDsVUCTrMCs0nzayO59GvMhfxQiCJM1LyNh%2B%2FS2jvrUZqKJXGmNQF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20180216T001726Z&X-Amz-SignedHeaders=host&X-Amz-Expires=518399&X-Amz-Credential=ASIAIDVYUYZXKN22OWZQ%2F20180216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=72120a45204f09768a7eeee9518dcd1e4324e2735905c9f1dd32c7a43f3cb13f"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| kind | string | false | none | Identifier used by Alvaria™ Cloud components to serialize the payload of the results. |
| nextToken | string | false | none | An obfuscated unique identifier of an object from cloud storage. Cloud Storage lists objects in UTF-8 character encoding in lexicographical order. |
| totalItems | integer | false | none | The total number of matching items, which would result from aggregating the items from all partial result sets given by the maxResults parameter. |
| objectKeys | [ObjectKeysFragment] | false | none | none |
ChildObjectKeysResponse
{
"key": "data-extracts/",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": [
{
"key": "data-extracts/",
"keyHash": "20524e222a70ca34d971b25c98496d62",
"keyName": "data-extracts",
"size": "4.3 kb",
"lastModifiedTime": "2017-11-30T13:01:58.247Z",
"keyType": "directory",
"childObjectKeys": []
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| key | boolean | false | none | Path to the object key |
| keyHash | string | false | none | Object key name |
| keyName | string | false | none | Object key name |
| size | string | false | none | Size of the object key in kilobytes. This is applicable for the file type object key only. |
| lastModifiedTime | string(date-time) | false | none | Last modified date for the object key |
| keyType | string | false | none | Type of file, which is File or Directory |
| childObjectKeys | [ChildObjectKeysResponse] | false | none | Sub-directories inside an object key |
Enumerated Values
| Property | Value |
|---|---|
| keyType | file |
| keyType | directory |
Error
{
"error": {
"code": "400",
"message": "Bad request",
"errors": [
{
"scope": "global",
"reason": "Invalid request",
"message": "The bucketName is invalid"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| error | ErrorResponse | true | none | none |
ErrorResponse
{
"code": "400",
"message": "Bad request",
"errors": [
{
"scope": "global",
"reason": "Invalid request",
"message": "The bucketName is invalid"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| code | integer | true | none | HTTP error status. |
| message | string | true | none | none |
| errors | [ErrorResponseItem] | true | none | none |
ErrorResponseItem
{
"scope": "global",
"reason": "Invalid request",
"message": "The bucketName is invalid"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| scope | string | true | none | none |
| reason | string | true | none | none |
| message | string | true | none | none |