logo
API docs by Redocly

Document Storage (2.13)

Download OpenAPI specification:Download

The Document Storage API provides the ability to centrally store, find, and download documents that are required for application and business needs.

Category

Resources related to categories.

Search Categories

Provides the ability to search for categories.

The response from this endpoint may be a partial list of results. If this is the case, then the below response headers will be populated. These headers can be supplied with a subsequent request to return the next set of search result(s).

Note that it is possible to retrieve an empty result set but still have continuation headers.

Authorizations:
SWT
query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

nextPartitionKey
string

Specifies a continuation token value, to be populated from the x-ms-continuation-NextPartitionKey response header of a previous call.

nextRowKey
string

Specifies a continuation token value, to be populated from the x-ms-continuation-NextRowKey response header of a previous call.

nextTableName
string

Specifies a continuation token value, to be populated from the x-ms-continuation-NextTableName response header of a previous call.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Category

Creates a new category

Authorizations:
SWT
Request Body schema: application/json
Description
string

Description of the category.

IsConfidential
boolean

Whether documents added to the category should be set to confidential.

Default: false

Name
required
string

Name of the category.

Responses

Request samples

Content type
application/json
{
  • "Description": "This category contains contract documents.",
  • "IsConfidential": false,
  • "Name": "Contracts"
}

Response samples

Content type
application/json
{
  • "CreateDate": "2014-06-23T21:00:22.007Z",
  • "CreateUser": "KHAR",
  • "Description": "This category contains contract documents.",
  • "Environment": "ENV01",
  • "ETag": "W/\\\"datetime'2016-01-20T17%3A08%3A50.8723773Z'\\\"",
  • "IsConfidential": true,
  • "ModifiedDate": "2014-06-23T21:00:22.007Z",
  • "ModifiedUser": "KHAR",
  • "Name": "Contracts",
  • "PartitionKey": "env01",
  • "RowKey": "contracts",
  • "Timestamp": "2016-01-20T17:08:50.872Z"
}

Get a Category

Retrieves a category.

Authorizations:
SWT
path Parameters
name
required
string

Name of the category to retrieve

Responses

Response samples

Content type
application/json
{
  • "CreateDate": "2014-06-23T21:00:22.007Z",
  • "CreateUser": "KHAR",
  • "Description": "This category contains contract documents.",
  • "Environment": "ENV01",
  • "ETag": "W/\\\"datetime'2016-01-20T17%3A08%3A50.8723773Z'\\\"",
  • "IsConfidential": true,
  • "ModifiedDate": "2014-06-23T21:00:22.007Z",
  • "ModifiedUser": "KHAR",
  • "Name": "Contracts",
  • "PartitionKey": "env01",
  • "RowKey": "contracts",
  • "Timestamp": "2016-01-20T17:08:50.872Z"
}

Update a Category

Updates certain properties of a category.

Authorizations:
SWT
path Parameters
name
required
string

Name of the category to update

Request Body schema: application/json
Description
string

Description of the category.

IsConfidential
boolean

Whether documents added to the category should be set to confidential.

Responses

Request samples

Content type
application/json
{
  • "Description": "New Contracts",
  • "IsConfidential": false
}

Delete a Category

Deletes a category.

Authorizations:
SWT
path Parameters
name
required
string

Name of the category to delete

Responses

Search Category Documents

Provides the ability to search for documents within a category.

The response from this endpoint may be a partial list of results. If this is the case, then the below response headers will be populated. These headers can be supplied with a subsequent request to return the next set of search result(s).

Note that it is possible to retrieve an empty result set but still have continuation headers.

Authorizations:
SWT
path Parameters
name
required
string

Name of the category in which to search for documents

query Parameters
$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$top
number
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

nextPartitionKey
string

Specifies a continuation token value, to be populated from the x-ms-continuation-NextPartitionKey response header of a previous call.

nextRowKey
string

Specifies a continuation token value, to be populated from the x-ms-continuation-NextRowKey response header of a previous call.

nextTableName
string

Specifies a continuation token value, to be populated from the x-ms-continuation-NextTableName response header of a previous call.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Document

Resources related to documents.

Upload a Document

Uploads a document

Authorizations:
SWT
Request Body schema: multipart/form-data
Application
required
string

The website, program, application, etc. that is uploading the document.

Note that this value will be saved in lower case.

Category
string

The category to which this document should be associated.

Default value: uncategorized

File
required
binary

The file to upload.

The following properties must be specified:

  • Content-Type: The type of content being uploaded.
  • FileName: The name of the file.
ForceConfidential
boolean

Makes the document confidential, regardless of the IsConfidential property of the associated category.

Name
string

Name of the file. If this value is not supplied, the FileName property from the File parameter will be used.

Notes
string

Any additional information to associate with the document.

Responses

Response samples

Content type
application/json
{
  • "Application": "MyWebApp",
  • "Category": "Contracts",
  • "ContentType": "application/pdf",
  • "CreateDate": "2014-06-23T21:00:22.007Z",
  • "CreateUser": "KHAR",
  • "Environment": "ENV01",
  • "ETag": "W/\\\"datetime'2016-01-20T17%3A08%3A50.8723773Z'\\\"",
  • "Extension": ".pdf",
  • "ExternalID": "2014071122382544-261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "IsConfidential": true,
  • "Key": "261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "ModifiedDate": "2014-06-23T21:00:22.007Z",
  • "ModifiedUser": "KHAR",
  • "Name": "contract001.pdf",
  • "Notes": "This contract is expired.",
  • "PartitionKey": "env01-contracts",
  • "RowKey": "2014071122382544-261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "SizeKB": 351.21,
  • "Timestamp": "2016-01-20T17:08:50.872Z"
}

Get a Document

Retrieves a document.

Authorizations:
SWT
path Parameters
externalId
required
string

The ExternalID of the document to retrieve

Responses

Overwrite a Document

Overwrites an existing document.

Authorizations:
SWT
path Parameters
externalId
required
string

The ExternalID of the document to overwrite

Request Body schema: multipart/form-data
Application
string

The website, program, application, etc. that is uploading the document.

Note that this value will be saved in lower case.

File
required
binary

The file to upload.

The following properties must be specified:

  • Content-Type: The type of content being uploaded.
  • FileName: The name of the file.
Name
string

Name of the file. If this value is not supplied, the FileName property from the File parameter will be used.

Responses

Response samples

Content type
application/json
{
  • "Application": "MyWebApp",
  • "Category": "Contracts",
  • "ContentType": "application/pdf",
  • "CreateDate": "2014-06-23T21:00:22.007Z",
  • "CreateUser": "KHAR",
  • "Environment": "ENV01",
  • "ETag": "W/\\\"datetime'2016-01-20T17%3A08%3A50.8723773Z'\\\"",
  • "Extension": ".pdf",
  • "ExternalID": "2014071122382544-261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "IsConfidential": true,
  • "Key": "261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "ModifiedDate": "2014-06-23T21:00:22.007Z",
  • "ModifiedUser": "KHAR",
  • "Name": "contract001.pdf",
  • "Notes": "This contract is expired.",
  • "PartitionKey": "env01-contracts",
  • "RowKey": "2014071122382544-261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "SizeKB": 351.21,
  • "Timestamp": "2016-01-20T17:08:50.872Z"
}

Delete a Document

Deletes a document.

Authorizations:
SWT
path Parameters
externalId
required
string

The ExternalID of the document to delete

Responses

Get Document Properties

Retrieves the properties of the document (not the document file contents).

Authorizations:
SWT
path Parameters
externalId
required
string

The ExternalID of the document for which to get the properties

Responses

Response samples

Content type
application/json
{
  • "Application": "MyWebApp",
  • "Category": "Contracts",
  • "ContentType": "application/pdf",
  • "CreateDate": "2014-06-23T21:00:22.007Z",
  • "CreateUser": "KHAR",
  • "Environment": "ENV01",
  • "ETag": "W/\\\"datetime'2016-01-20T17%3A08%3A50.8723773Z'\\\"",
  • "Extension": ".pdf",
  • "ExternalID": "2014071122382544-261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "IsConfidential": true,
  • "Key": "261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "ModifiedDate": "2014-06-23T21:00:22.007Z",
  • "ModifiedUser": "KHAR",
  • "Name": "contract001.pdf",
  • "Notes": "This contract is expired.",
  • "PartitionKey": "env01-contracts",
  • "RowKey": "2014071122382544-261722ce-1ffd-45ce-bc95-e3b65c66f767",
  • "SizeKB": 351.21,
  • "Timestamp": "2016-01-20T17:08:50.872Z"
}

Update Document Properties

Updates certain properties of a document.

Authorizations:
SWT
path Parameters
externalId
required
string

The ExternalID of the document for which to update the properties

Request Body schema: application/json
IsConfidential
boolean

Whether the document is considered to be confidential.

Name
string

Name of the document.

Notes
string

Notes associated with the document.

Responses

Request samples

Content type
application/json
{
  • "IsConfidential": true,
  • "Name": "contract002.pdf",
  • "Notes": "This is the updated contract."
}

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the Document Storage service is up and running. [Rev 1.16]

Authorizations:
SWT

Responses

Release Notes

Release Notes 2.13

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.12

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.11

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.10

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.09

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.08

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.07

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.06

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.05

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.04

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.03

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.02

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.01

  • Only internal changes were made this release. There were no API changes.

Release Notes 2.00

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.16

Release Notes 1.15

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.14

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.13

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.12

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.11

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.10

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.09

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.08

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.07

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.06

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.05

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.04

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.03

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.02

  • Only internal changes were made this release. There were no API changes.

Release Notes 1.01

Release Notes 1.00

  • Initial release of Document Storage API.