Vault v0.3.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.

The Vault API manages secure content files and document storage for other Apiture APIs and application use. Documents which may be stored in Vault include Terms and Conditions, privacy statements, check images, statements, images/documents required for an account application, etc. Clients may upload and download files with this API, or search for files by date or type or role. Files may be organized into hierarchical folders. Each file has a JSON representation file descriptor which includes the attributes (metadata) of the file (the name, type, size, _links, etc.), and a content resource which accesses the text or binary content of the file. The content URI is available via the apiture:content link in the file descriptor. The _links of a file or folder include an apiture:folder link to its containing folder. Each folder has apiture:files and apiture:children links to its directly contained files and subfolders, respectively.

To upload a file, first POST a request to the /uploads path (the createUpload operation) containing file descriptor(s) to be uploaded. When uploading a new file, the caller may specify a desired target folder by setting the apiture:folder link within the request's _links. The upload tracker response from the upload operation contains an array of items, one for each file to upload. Each item in the array contains an apiture:uploadUrl link, which is an upload URL for the corresponding file. The client should next PUT the file(s) content to the upload URLs to upload the files' contents. The upload is done when the upload resource state is completed or failed. The upload resource will contain the file descriptor resources in the items array within the _embedded object; each file will include a self link to the corresponding file resource.

After a file has been created, the file resource contains links to its containing folder, the public share URI, and the content URI for downloading the file's content.

For files which reside in folders with revisions enabled, updating a file's content creates a new revision of the file. The revisions are available from the file's /files/{fileId}/revisions collection.

Download OpenAPI Definition (YAML)

Base URLs:

• /vault

Terms of service

Email: Apiture Web: Apiture

License: Pending.

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET /vault/ \
  -H 'Accept: application/hal+json'

GET /vault/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/vault/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/vault/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET /

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.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/apiRoot/v1.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /vault/apiDoc \
  -H 'Accept: application/json'

GET /vault/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: '/vault/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('/vault/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/vault/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/vault/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{}

Responses

Response Schema

Upload

Requests to upload new files into the file vault.

getUploads

Code samples

# You can also use wget
curl -X GET /vault/uploads \
  -H 'Accept: application/hal+json'

GET /vault/uploads HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/uploads',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/uploads',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/vault/uploads',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/vault/uploads', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/uploads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/uploads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of recent and in progress uploads

GET /uploads

Return a paginated sortable filterable searchable collection of uploads. The links in the response include pagination links. Upload resources expire after a while and these resources are automatically deleted.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/collection/upload/v1.0.0/profile.json",
  "start": 10,
  "limit": 10,
  "count": 2,
  "name": "uploads",
  "_links": {
    "self": {
      "href": "/vault/uploads?start=10&limit=10"
    },
    "first": {
      "href": "/vault/uploads?start=0&limit=10"
    },
    "next": {
      "href": "/vault/uploads?start=100&limit=100"
    },
    "collection": {
      "href": "/vault/uploads"
    },
    "apiture:myUploads": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "d3a954aa-2027-4e92-b5b0-136bf31b1837",
        "count": 1,
        "name": "files",
        "_embedded": [
          {
            "name": "image1.png",
            "contentType": "image/png"
          },
          {
            "name": "image2.png",
            "contentType": "image/png"
          }
        ],
        "_links": {
          "self": {
            "href": "/vault/uploads/d3a954aa-2027-4e92-b5b0-136bf31b1837"
          }
        }
      },
      {
        "_id": "70ac012a-d66a-4a2a-8286-916dfda25799",
        "count": 1,
        "name": "files",
        "_links": {
          "self": {
            "href": "/vault/uploads/70ac012a-d66a-4a2a-8286-916dfda25799"
          }
        }
      }
    ]
  }
}

Responses

createUpload

Code samples

# You can also use wget
curl -X POST /vault/uploads \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /vault/uploads HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/uploads',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/upload/v1.0.0/profile.json",
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg"
      },
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg"
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/vault/uploads',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/vault/uploads',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/vault/uploads', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/uploads");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/vault/uploads", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new upload

POST /uploads

Create a new file upload tracker. The caller provides a list of one or more files to be uploaded in _embedded.items.

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.

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.

The target folder in which the file will be stored may be specified in _links using the apiture:folder link relation name.

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.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/upload/v1.0.0/profile.json",
  "count": 2,
  "name": "files",
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg"
      },
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg"
      }
    ]
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/upload/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/uploads/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    },
    "items": [
      {
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "/some/opaque/upload/url/for/this/file"
          }
        }
      },
      {
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "/some/opaque/upload/url/for/this/file"
          }
        }
      }
    ]
  },
  "count": 2,
  "name": "files",
  "state": "pending",
  "expiresAt": "2017-12-23T00:00:00.000Z",
  "maximumFileSizeBytes": 25000000,
  "maximumReqestSizeBytes": 50000000
}

Responses

Response Headers

getUpload

Code samples

# You can also use wget
curl -X GET /vault/uploads/{uploadId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /vault/uploads/{uploadId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/vault/uploads/{uploadId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/vault/uploads/{uploadId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/vault/uploads/{uploadId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/vault/uploads/{uploadId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/uploads/{uploadId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/uploads/{uploadId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this upload

GET /uploads/{uploadId}

Return a HAL representation of this upload resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/upload/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/uploads/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    },
    "items": [
      {
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "/some/opaque/upload/url/for/this/file"
          }
        }
      },
      {
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "apiture:uploadUrl": {
            "href": "/some/opaque/upload/url/for/this/file"
          }
        }
      }
    ]
  },
  "count": 2,
  "name": "files",
  "state": "pending",
  "expiresAt": "2017-12-23T00:00:00.000Z",
  "maximumFileSizeBytes": 25000000,
  "maximumReqestSizeBytes": 50000000
}

Responses

Response Headers

deleteUpload

Code samples

# You can also use wget
curl -X DELETE /vault/uploads/{uploadId}

DELETE /vault/uploads/{uploadId} HTTP/1.1

$.ajax({
  url: '/vault/uploads/{uploadId}',
  method: 'delete',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('/vault/uploads/{uploadId}',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

result = RestClient.delete '/vault/uploads/{uploadId}',
  params: {
  }

p JSON.parse(result)

import requests

r = requests.delete('/vault/uploads/{uploadId}', params={

)

print r.json()

URL obj = new URL("/vault/uploads/{uploadId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/vault/uploads/{uploadId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this upload resource

DELETE /uploads/{uploadId}

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.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Responses

uploadContent

Code samples

# You can also use wget
curl -X POST /vault/uploads/{uploadId}/content \
  -H 'Content-Type: */*' \
  -H 'Accept: application/hal+json' \
  -H 'Content-Type: string'

POST /vault/uploads/{uploadId}/content HTTP/1.1

Content-Type: */*
Accept: application/hal+json
Content-Type: string

var headers = {
  'Content-Type':'*/*',
  'Accept':'application/hal+json',
  'Content-Type':'string'

};

$.ajax({
  url: '/vault/uploads/{uploadId}/content',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'string';
const headers = {
  'Content-Type':'*/*',
  'Accept':'application/hal+json',
  'Content-Type':'string'

};

fetch('/vault/uploads/{uploadId}/content',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => '*/*',
  'Accept' => 'application/hal+json',
  'Content-Type' => 'string'
}

result = RestClient.post '/vault/uploads/{uploadId}/content',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': '*/*',
  'Accept': 'application/hal+json',
  'Content-Type': 'string'
}

r = requests.post('/vault/uploads/{uploadId}/content', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/uploads/{uploadId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"*/*"},
        "Accept": []string{"application/hal+json"},
        "Content-Type": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/vault/uploads/{uploadId}/content", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

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

POST /uploads/{uploadId}/content

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.

Body parameter

string

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json",
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_links": {
    "self": {
      "href": "/vault/files?start=0&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "first": {
      "href": "/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "/vault/files?start=100&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "collection": {
      "href": "/vault/files",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

File

A file (document) in the file vault.

getFiles

Code samples

# You can also use wget
curl -X GET /vault/files \
  -H 'Accept: application/hal+json'

GET /vault/files HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/files',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/files',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/vault/files',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/vault/files', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/files", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of files

GET /files

Return a paginated sortable filterable searchable collection of files. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json",
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_links": {
    "self": {
      "href": "/vault/files?start=0&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "first": {
      "href": "/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "/vault/files?start=100&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "collection": {
      "href": "/vault/files",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

createFile

Code samples

# You can also use wget
curl -X POST /vault/files \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /vault/files HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/files',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/vault/files',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/vault/files',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/vault/files', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/vault/files", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new file

POST /files

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.

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.

The file will be placed in the folder specified in the apiture:folder link, which should be derievd from the apiture:folder specified in upload request. If no folder was specified, the file is placed in the user's uploads folder.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
      "profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:content": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture",
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

Response Headers

getFile

Code samples

# You can also use wget
curl -X GET /vault/files/{fileId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /vault/files/{fileId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/vault/files/{fileId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/vault/files/{fileId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the file descriptor

GET /files/{fileId}

Return a HAL representation of this file resource. The Content-Location response header, if present, identifies the equivalent revision.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
      "profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:content": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture",
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

Response Headers

updateFile

Code samples

# You can also use wget
curl -X PUT /vault/files/{fileId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PUT /vault/files/{fileId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/vault/files/{fileId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "name": "myAvatar.png",
  "description": "My personal avatar"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/vault/files/{fileId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.put '/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.put('/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this file descriptor

PUT /files/{fileId}

Perform a complete replacement of this file's descriptor.

Body parameter

{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "name": "myAvatar.png",
  "description": "My personal avatar"
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
      "profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:content": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture",
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

Response Headers

patchFile

Code samples

# You can also use wget
curl -X PATCH /vault/files/{fileId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PATCH /vault/files/{fileId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/vault/files/{fileId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "name": "myAvatar.png",
  "description": "My personal avatar"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/vault/files/{fileId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.patch '/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.patch('/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this file's descriptor

PATCH /files/{fileId}

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

Body parameter

{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "name": "myAvatar.png",
  "description": "My personal avatar"
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b",
      "profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:content": {
      "href": "/vault/files/7dc00a42-76f9-4bbb-bda3-bd6ed203c01b/content",
      "type": "images/png"
    },
    "apiture:share": {
      "href": "/vault/content/6b580037-2d4f-4b91-bb3f-175b668fb856.png"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "avatar.png",
  "contentType": "image/png",
  "description": "My personal avatar",
  "type": "profilePicture",
  "sizeBytes": 112800,
  "createdAt": "2018-01-04T07:00:49.375Z"
}

Responses

Response Headers

deleteFile

Code samples

# You can also use wget
curl -X DELETE /vault/files/{fileId} \
  -H 'Accept: application/hal+json'

DELETE /vault/files/{fileId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/files/{fileId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/files/{fileId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.delete '/vault/files/{fileId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.delete('/vault/files/{fileId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/vault/files/{fileId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this file resource

DELETE /files/{fileId}

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

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

404 Response

{
  "_profile": "https://api.apiture.com/schemas/error/v1.0.0/.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.693Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

getFileRevisions

Code samples

# You can also use wget
curl -X GET /vault/files/{fileId}/revisions \
  -H 'Accept: application/hal+json'

GET /vault/files/{fileId}/revisions HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/files/{fileId}/revisions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/files/{fileId}/revisions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/vault/files/{fileId}/revisions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/vault/files/{fileId}/revisions', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}/revisions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/files/{fileId}/revisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of file revisions

GET /files/{fileId}/revisions

Return a paginated sortable filterable searchable collection of file revisions. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json",
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_links": {
    "self": {
      "href": "/vault/files?start=0&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "first": {
      "href": "/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "/vault/files?start=100&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "collection": {
      "href": "/vault/files",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

getFileRevision

Code samples

# You can also use wget
curl -X GET /vault/files/{fileId}/revisions/{revisionId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /vault/files/{fileId}/revisions/{revisionId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/vault/files/{fileId}/revisions/{revisionId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/vault/files/{fileId}/revisions/{revisionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/vault/files/{fileId}/revisions/{revisionId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/vault/files/{fileId}/revisions/{revisionId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}/revisions/{revisionId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/files/{fileId}/revisions/{revisionId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of an immutable revision of this file

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

Return an immutable 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.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json",
  "start": 0,
  "limit": 100,
  "count": 2,
  "name": "files",
  "_links": {
    "self": {
      "href": "/vault/files?start=0&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "first": {
      "href": "/vault/files?start=0&limit=10"
    },
    "next": {
      "href": "/vault/files?start=100&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "collection": {
      "href": "/vault/files",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "items": [
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "54867739-eca4-434d-8869-8fe6a6248f55",
        "contentType": "image/jpg",
        "type": "checkImageFront",
        "description": "Image of the front of a mobile check deposit for transaction 3839827893",
        "name": "check-front-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/54867739-eca4-434d-8869-8fe6a6248f55"
          }
        }
      },
      {
        "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
        "_id": "70955bd8-0bc2-4129-9117-cc7749406cfe",
        "contentType": "image/jpg",
        "type": "checkImageBack",
        "description": "Image of the back of a mobile check deposit for transaction 3839827893",
        "name": "check-back-3839827893.jpg",
        "_links": {
          "self": {
            "href": "/vault/files/70955bd8-0bc2-4129-9117-cc7749406cfe"
          }
        }
      }
    ]
  }
}

Responses

Response Headers

getFileContent

Code samples

# You can also use wget
curl -X GET /vault/files/{fileId}/content \
  -H 'Accept: */*'

GET /vault/files/{fileId}/content HTTP/1.1

Accept: */*

var headers = {
  'Accept':'*/*'

};

$.ajax({
  url: '/vault/files/{fileId}/content',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*'

};

fetch('/vault/files/{fileId}/content',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get '/vault/files/{fileId}/content',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('/vault/files/{fileId}/content', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/files/{fileId}/content");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/files/{fileId}/content", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return the raw content of the file

GET /files/{fileId}/content

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

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

404 Response

{
  "_profile": "https://api.apiture.com/schemas/error/v1.0.0/.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.693Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Response Headers

getSharedContent

Code samples

# You can also use wget
curl -X GET /vault/content/{contentId} \
  -H 'Accept: */*'

GET /vault/content/{contentId} HTTP/1.1

Accept: */*

var headers = {
  'Accept':'*/*'

};

$.ajax({
  url: '/vault/content/{contentId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'*/*'

};

fetch('/vault/content/{contentId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*'
}

result = RestClient.get '/vault/content/{contentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': '*/*'
}

r = requests.get('/vault/content/{contentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/content/{contentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"*/*"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/content/{contentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Get a shared file's content

GET /content/{contentId}

/content/{contentId} represents the shared URL Return the raw content of the file as a stream of bytes. This operation normally returns a 303 to redirect the caller to the actual URL where the file conent is available.

**TODO**: Add a `delete` method to unshare a file.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

404 Response

{
  "_profile": "https://api.apiture.com/schemas/error/v1.0.0/.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.693Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Response Headers

Folder

A container for files and other folders.

getFolders

Code samples

# You can also use wget
curl -X GET /vault/folders \
  -H 'Accept: application/hal+json'

GET /vault/folders HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/folders',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/folders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.get '/vault/folders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.get('/vault/folders', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/folders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/folders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of folders

GET /folders

Return a paginated sortable filterable searchable collection of folders. The links in the response include pagination links.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json",
  "start": 0,
  "limit": 100,
  "count": 17,
  "name": "folders",
  "_links": {
    "self": {
      "href": "/vault/folders?start=0&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    },
    "first": {
      "href": "/basePath/folders?start=0&limit=10"
    },
    "next": {
      "href": "/vault/folders?start=100&limit=100",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    },
    "collection": {
      "href": "/vault/folders",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "items": [
      {
        "name": "...",
        "description": "...",
        "_links": {
          "self": {
            "href": "..."
          }
        }
      }
    ]
  }
}

Responses

createFolder

Code samples

# You can also use wget
curl -X POST /vault/folders \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json'

POST /vault/folders HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/folders',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents.",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json'

};

fetch('/vault/folders',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json'
}

result = RestClient.post '/vault/folders',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json'
}

r = requests.post('/vault/folders', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/folders");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/vault/folders", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new folder

POST /folders

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.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents.",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:files": {
      "href": "/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "apiture:children": {
      "href": "/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "My uploads",
  "createdAt": "2018-01-04T08:22:24.375Z",
  "type": "any"
}

Responses

Response Headers

getFolder

Code samples

# You can also use wget
curl -X GET /vault/folders/{folderId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string'

GET /vault/folders/{folderId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

$.ajax({
  url: '/vault/folders/{folderId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string'

};

fetch('/vault/folders/{folderId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string'
}

result = RestClient.get '/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string'
}

r = requests.get('/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this folder

GET /folders/{folderId}

Return a HAL representation of this folder resource.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:files": {
      "href": "/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "apiture:children": {
      "href": "/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "My uploads",
  "createdAt": "2018-01-04T08:22:24.375Z",
  "type": "any"
}

Responses

Response Headers

updateFolder

Code samples

# You can also use wget
curl -X PUT /vault/folders/{folderId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PUT /vault/folders/{folderId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/vault/folders/{folderId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "c78e62e9-9380-4432-8f6c-99a8710b2f74",
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/vault/folders/{folderId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.put '/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.put('/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this folder

PUT /folders/{folderId}

Perform a complete replacement of this folder.

Body parameter

{
  "_id": "c78e62e9-9380-4432-8f6c-99a8710b2f74",
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:files": {
      "href": "/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "apiture:children": {
      "href": "/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "My uploads",
  "createdAt": "2018-01-04T08:22:24.375Z",
  "type": "any"
}

Responses

Response Headers

patchFolder

Code samples

# You can also use wget
curl -X PATCH /vault/folders/{folderId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string'

PATCH /vault/folders/{folderId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

$.ajax({
  url: '/vault/folders/{folderId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "c78e62e9-9380-4432-8f6c-99a8710b2f74",
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string'

};

fetch('/vault/folders/{folderId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string'
}

result = RestClient.patch '/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string'
}

r = requests.patch('/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this folder

PATCH /folders/{folderId}

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

Body parameter

{
  "_id": "c78e62e9-9380-4432-8f6c-99a8710b2f74",
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    }
  }
}

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/file/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:folder": {
      "href": "/vault/folders/0094eabb-75e8-49f6-b8f4-0af7cb69eb55",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    },
    "apiture:files": {
      "href": "/vault/files?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/file/v1.0.0/profile.json"
    },
    "apiture:children": {
      "href": "/vault/folders?folder=0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/collection/folder/v1.0.0/profile.json"
    }
  },
  "_embedded": {
    "other": {
      "_id": "2f41f97f-f8d2-4ec1-89f5-c7c9d2583aad",
      "_profile": "https://api.apiture.com/schemas/other/v1.0.0/profile.json"
    }
  },
  "name": "My uploads",
  "createdAt": "2018-01-04T08:22:24.375Z",
  "type": "any"
}

Responses

Response Headers

deleteFolder

Code samples

# You can also use wget
curl -X DELETE /vault/folders/{folderId} \
  -H 'Accept: application/hal+json'

DELETE /vault/folders/{folderId} HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json'

};

$.ajax({
  url: '/vault/folders/{folderId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json'

};

fetch('/vault/folders/{folderId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json'
}

result = RestClient.delete '/vault/folders/{folderId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json'
}

r = requests.delete('/vault/folders/{folderId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/vault/folders/{folderId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/vault/folders/{folderId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this folder resource

DELETE /folders/{folderId}

Delete this folder.

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.

The user may not delete their top-level folder.

Parameters

Try it

Fields marked with * are mandatory.

Response

    
      Click on 'Try It' to get a response.
    
  

Example responses

404 Response

{
  "_profile": "https://api.apiture.com/schemas/error/v1.0.0/.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/error/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2019-01-31T13:31:40.693Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Schemas

folderFields

{
  "name": "My uploads",
  "description": "Default folder where new files are uploaded",
  "type": "any"
}

Folder Fields

Properties

summaryFolder

{
  "_id": "0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2",
      "profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json"
    }
  },
  "name": "My uploads",
  "description": "Default folder where new files are uploaded.",
  "type": "any"
}

Folder Summary

Properties

allOf

and

createFolder

{
  "_profile": "https://api.apiture.com/schemas/folder/v1.0.0/profile.json",
  "name": "My account application documents",
  "description": "Default folder for account application documents.",
  "type": "any",
  "_links": {
    "apiture:folder": {
      "href": "/vault/folders/0cbd28ca-27f7-47fa-a223-ce4f91dcc2b2"
    }
  }
}