Vault

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. Links in the root response may include: * *`apiture:files`* : A link to the collection of all files. * *`apiture:folders`* : A link to the collection of all folders. * *`apiture:uploads`* : A link to the collection of all upload tasks. * *`apiture:myFolder`* : A link to the currently authenticated user's primary folder. * *`apiture:myUploads`* : A link to the currently authenticated user's primary upload folder, a child folder of the user's primary folder.


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/"
import { APIApi } from "@apiture/vault-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Vault.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/apiDoc"
import { APIApi } from "@apiture/vault-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Vault.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


File

createFile

Create a new file

Create a new file in the files collection. This operation is called upon successful completion of an upload operation and associates the file descriptor (name, description, parent folder, etc.) with the file contents. <p> If there is already a file of the same name in the target folder, the file is renamed by adding a unique numeric suffix in parentheses. For example, if `tax-summary-2018.pdf` already exists, uploading a new document with that name will be renamed `tax-summary-2018 (1).pdf`. <p> The file will be placed in the folder specified in the *`apiture:folder`* link, which should be derived from the *`apiture:folder`* specified in upload request. If no folder was specified, the file is placed in the user's uploads folder.


/files

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///vault/files"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.createFile()
var createFile = ; // {CreateFile} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.createFile(createFile, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createFile *

The data necessary to create a new file.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with `/` it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteFile

Delete this file resource

Delete this file resource and any resources that are owned by it.


/files/{fileId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.deleteFile()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
fileApi.deleteFile(fileId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getFile

Fetch the file descriptor

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this file resource. The `Content-Location` response header, if present, identifies the equivalent revision.


/files/{fileId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.getFile()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.getFile(fileId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this file resource.
ContentMinusLocation String The `Content-Location` will contain the URI of the specific revision corresponding to this file resource.


getFileContent

Return the raw content of the file

Return the raw content of the file as a stream of bytes. This operation normally returns a 302 to redirect the caller to the actual URL where the file content is available.


/files/{fileId}/content

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}/content"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.getFileContent()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.getFileContent(fileId, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required

Responses

Name Type Format Description
ContentMinusType String The media type of the file content.

Name Type Format Description
Location String The URL where the file's content is located.


getFileRevision

Fetch a representation of an immutable revision of this file

Return an immutable [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this revision of this file resource. The revision may also have `prev` and `next` links to previous and/or next revisions, if they exist.


/files/{fileId}/revisions/{revisionId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}/revisions/{revisionId}"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.getFileRevision()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.
var revisionId = revisionId_example; // {String} The identifier for a revision of this resource. Revision identifiers use ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.getFileRevision(fileId, revisionId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required
revisionId*
String
The identifier for a revision of this resource. Revision identifiers use ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ`.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this file resource.


getFileRevisions

Return a collection of file revisions

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of file revisions. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/files/{fileId}/revisions

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}/revisions?start=&limit=&sortBy=&filter=&q="
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.getFileRevisions()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.
var opts = {
  'start': 789, // {Long} The zero-based index of the first product revision item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of product representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.getFileRevisions(fileId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required
Query parameters
Name Description
start
Long (int64)
The zero-based index of the first product revision item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of product representations to return in this page.
sortBy
String
Optional sort criteria. Revision collections are sorted by default in reverse chronological order (most recent revision first). See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


getFiles

Return a collection of files

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of files. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/files

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/files?start=&limit=&sortBy=&name=&type=&filter=&q=&folder="
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.getFiles()
var opts = {
  'start': 789, // {Long} The zero-based index of the first file in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of file representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'name': name_example, // {String} Subset the files collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the files collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment%20Account` matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'folder': folder_example // {String} Subset the response to resources that reside directly within the specified folder. The value may be a folder ID or a folder URI.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.getFiles(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first file in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of file representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
name
String
Subset the files collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the files collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment%20Account` matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
folder
String
Subset the response to resources that reside directly within the specified folder. The value may be a folder ID or a folder URI.

Responses


getSharedContent

Get a shared file's content

`/content/{contentId}` represents the _shared_ URL Return the raw content of the file as a stream of bytes. This operation normally returns a 302 to redirect the caller to the actual URL where the file content is available. In the future, a `delete` method will unshare a file.


/content/{contentId}

Usage and SDK Samples

curl -X GET "http:///vault/content/{contentId}"
import { FileApi } from "@apiture/vault-client-sdk";

var api = new Vault.FileApi.getSharedContent()
var contentId = contentId_example; // {String} The unique ID that refers to a file's raw content and represents the publicly _shared_ file.  This  ID is not related to the `{fileId}` and can be revoked when the user decides to unshare a file.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.getSharedContent(contentId, callback);

Scopes

Parameters

Path parameters
Name Description
contentId*
String
The unique ID that refers to a file's raw content and represents the publicly _shared_ file. This ID is not related to the `{fileId}` and can be revoked when the user decides to unshare a file.
Required

Responses

Name Type Format Description
ContentMinusType String The media type of the file content.

Name Type Format Description
Location String The URL where the file's content is located.


patchFile

Update this file's descriptor

Perform a partial update of this file's descriptor. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/files/{fileId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.patchFile()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.
var updateFile = ; // {UpdateFile} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.patchFile(fileId, updateFile, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateFile *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this file resource.


updateFile

Update this file descriptor

Perform a complete replacement of this file's descriptor.


/files/{fileId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///vault/files/{fileId}"
import { FileApi } from "@apiture/vault-client-sdk";

const fileApi = new FileApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fileApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fileApi.setApiKey(apiKey);


var api = new Vault.FileApi.updateFile()
var fileId = fileId_example; // {String} The unique identifier of this file. This is an opaque string.
var updateFile = ; // {UpdateFile} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
fileApi.updateFile(fileId, updateFile, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
fileId*
String
The unique identifier of this file. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateFile *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this file resource.


Folder

createFolder

Create a new folder

Create a new folder in the folders collection. To locate the folder within an existing folder (as a subfolder), specify the desired target folder with the *`apiture:folder`* link within the request body's `_links`.


/folders

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///vault/folders"
import { FolderApi } from "@apiture/vault-client-sdk";

const folderApi = new FolderApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
folderApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
folderApi.setApiKey(apiKey);


var api = new Vault.FolderApi.createFolder()
var createFolder = ; // {CreateFolder} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
folderApi.createFolder(createFolder, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createFolder *

The data necessary to create a new folder.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`.


deleteFolder

Delete this folder resource

Delete this folder. <p> Normally, one can only delete a folder if it is empty (contains no files or subfolders). With the `?recursive=true` option, this operation will delete a non-empty folder and its contents, including nested folders. The user must have authorization to delete all the contents. <p> The user may not delete their top-level folder.


/folders/{folderId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///vault/folders/{folderId}?recursive="
import { FolderApi } from "@apiture/vault-client-sdk";

const folderApi = new FolderApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
folderApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
folderApi.setApiKey(apiKey);


var api = new Vault.FolderApi.deleteFolder()
var folderId = folderId_example; // {String} The unique identifier of this folder. This is an immutable opaque string.
var opts = {
  'ifMatch': ifMatch_example, // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
  'recursive': true // {Boolean} If true, also delete all files and nested folders that are stored in this folder.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
folderApi.deleteFolder(folderId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
folderId*
String
The unique identifier of this folder. This is an immutable opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
recursive
Boolean
If true, also delete all files and nested folders that are stored in this folder.

Responses


getFolder

Fetch a representation of this folder

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this folder resource.


/folders/{folderId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/folders/{folderId}"
import { FolderApi } from "@apiture/vault-client-sdk";

const folderApi = new FolderApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
folderApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
folderApi.setApiKey(apiKey);


var api = new Vault.FolderApi.getFolder()
var folderId = folderId_example; // {String} The unique identifier of this folder. This is an immutable opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
folderApi.getFolder(folderId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
folderId*
String
The unique identifier of this folder. This is an immutable opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this folder resource.


getFolders

Return a collection of folders

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of folders. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/folders

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/folders?start=&limit=&sortBy=&name=&filter=&q=&folder="
import { FolderApi } from "@apiture/vault-client-sdk";

const folderApi = new FolderApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
folderApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
folderApi.setApiKey(apiKey);


var api = new Vault.FolderApi.getFolders()
var opts = {
  'start': 789, // {Long} The zero-based index of the first folder in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of folder representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'name': name_example, // {String} Subset the folders collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'folder': folder_example // {String} Subset the response to resources that reside directly within the specified folder. The value may be a folder ID or a folder URI.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
folderApi.getFolders(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first folder in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of folder representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
name
String
Subset the folders collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
folder
String
Subset the response to resources that reside directly within the specified folder. The value may be a folder ID or a folder URI.

Responses


patchFolder

Update this folder

Perform a partial update of this folder. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/folders/{folderId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///vault/folders/{folderId}"
import { FolderApi } from "@apiture/vault-client-sdk";

const folderApi = new FolderApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
folderApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
folderApi.setApiKey(apiKey);


var api = new Vault.FolderApi.patchFolder()
var folderId = folderId_example; // {String} The unique identifier of this folder. This is an immutable opaque string.
var updateFolder = ; // {UpdateFolder} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
folderApi.patchFolder(folderId, updateFolder, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
folderId*
String
The unique identifier of this folder. This is an immutable opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateFolder *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this folder resource.


updateFolder

Update this folder

Perform a complete replacement of this folder.


/folders/{folderId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///vault/folders/{folderId}"
import { FolderApi } from "@apiture/vault-client-sdk";

const folderApi = new FolderApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
folderApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
folderApi.setApiKey(apiKey);


var api = new Vault.FolderApi.updateFolder()
var folderId = folderId_example; // {String} The unique identifier of this folder. This is an immutable opaque string.
var updateFolder = ; // {UpdateFolder} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
folderApi.updateFolder(folderId, updateFolder, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
folderId*
String
The unique identifier of this folder. This is an immutable opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
updateFolder *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this folder resource.


Upload

createUpload

Create a new upload

Create a new file upload tracker. The caller provides a list of one or more files to be uploaded in `_embedded.items`. <p> This operation returns a modified _upload tracker_ resource representation which contains embedded file descriptors. Each file descriptor contain the file name, type, etc. and a link named `apiture:uploadUrl` which points to an upload URL. The client must `PUT` the file content to those respective URLs to complete the uploads. </p> <p> The `state` of the upload tracker shows the upload status. When the `state` is `completes`, the files associated with the upload will be in this resource's `_embedded` object with the name `files`; that value an array of file descriptor objects. </p> <p> The target folder in which the file will be stored may be specified in `_links` using the *`apiture:folder`* link relation name. </p> <p> If there is already a file of the same name in the target folder, the file is renamed by adding or incrementing a unique numeric suffix in parentheses. For example, if `tax-summary-2018.pdf` already exists, uploading a new document with that name will be renamed `tax-summary-2018 (1).pdf`; uploading another file will be renamed `tax-summary-2018 (2).pdf`, and so on. </p> **TODO** In the future, this API will also support uploading new revisions of the document and maintaining document revision history.


/uploads

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///vault/uploads"
import { UploadApi } from "@apiture/vault-client-sdk";

const uploadApi = new UploadApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
uploadApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
uploadApi.setApiKey(apiKey);


var api = new Vault.UploadApi.createUpload()
var createUpload = ; // {CreateUpload} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
uploadApi.createUpload(createUpload, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createUpload *

The data necessary to create a new upload.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteUpload

Delete this upload resource

Delete this upload resource and any resources that are owned by it. Note that deleting an upload does _not_ delete any files that have been uploaded.


/uploads/{uploadId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///vault/uploads/{uploadId}"
import { UploadApi } from "@apiture/vault-client-sdk";

const uploadApi = new UploadApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
uploadApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
uploadApi.setApiKey(apiKey);


var api = new Vault.UploadApi.deleteUpload()
var uploadId = uploadId_example; // {String} The unique identifier of this upload. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
uploadApi.deleteUpload(uploadId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
uploadId*
String
The unique identifier of this upload. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getUpload

Fetch a representation of this upload

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this upload resource.


/uploads/{uploadId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/uploads/{uploadId}"
import { UploadApi } from "@apiture/vault-client-sdk";

const uploadApi = new UploadApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
uploadApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
uploadApi.setApiKey(apiKey);


var api = new Vault.UploadApi.getUpload()
var uploadId = uploadId_example; // {String} The unique identifier of this upload. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
uploadApi.getUpload(uploadId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
uploadId*
String
The unique identifier of this upload. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this upload resource.


getUploads

Return a collection of recent and in progress uploads

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of uploads. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. Upload resources expire after a while and these resources are automatically deleted.


/uploads

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///vault/uploads?start=&limit=&sortBy=&name=&filter=&q="
import { UploadApi } from "@apiture/vault-client-sdk";

const uploadApi = new UploadApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
uploadApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
uploadApi.setApiKey(apiKey);


var api = new Vault.UploadApi.getUploads()
var opts = {
  'start': 789, // {Long} The zero-based index of the first upload in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of upload representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'name': name_example, // {String} Subset the uploads collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
uploadApi.getUploads(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first upload in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of upload representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
name
String
Subset the uploads collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` matches only items whose name is Bartell; `?name=Bartell|kirsten` matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


uploadContent

Upload the file's raw content to the corresponding file resource.

Upload the raw content of the file as a stream of bytes. Examples include the binary bytes for an image or PDF document, or the `multipart/form-data` representation of the file. The `Content-Type` header (or the `Content-Type` in the multipart form data) must match the `contentType` of the file resource. The response is the `/files/{fileId}` file resource, not the file content. *Note*: This is a _hidden_ operation which is a proxy for the `apiture:uploadUrl` link returned when creating a new upload in the `createUpload` operation. Clients should *not* assume this URL exists but should instead use the `apiture:uploadUrl` link that is returned when creating a new upload resource. If the file is in a folder for which revisions are enable, this will create a new revision of the file; see the `getFileRevisions` and `getFileRevision` operations.


/uploads/{uploadId}/content

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///vault/uploads/{uploadId}/content"
import { UploadApi } from "@apiture/vault-client-sdk";

const uploadApi = new UploadApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
uploadApi.setApiKey(apiKey);


var api = new Vault.UploadApi.uploadContent()
var uploadId = uploadId_example; // {String} The unique identifier of this upload. This is an opaque string.
var contentType = contentType_example; // {String} The media type describing the file's content type.
var body = BINARY_DATA_HERE; // {File} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
uploadApi.uploadContent(uploadId, contentType, body, callback);

Scopes

Parameters

Path parameters
Name Description
uploadId*
String
The unique identifier of this upload. This is an opaque string.
Required
Header parameters
Name Description
Content-Type*
String
The media type describing the file's content type.
Required
Body parameters
Name Description
body *

The file contents as a stream of bytes.

Responses