Metadata

This is the endpoint used to work with the metadata of the document. Here we will find operations to download or update the whole metadata, and to work with specific parts of the metadata, like categories (download, add, remove) or retention(assign or unassign).

Get Metadata

GET https://api.everisbigcontent.com/edms/rest/v1/metadata/{id}

Retrieves the whole metadata of the specified document.

Parameters

HTTP Headers

HTTP headers allow pass additional information with the request or the response. BigContent headers are used for recurrent details like authentication or document store.

Table 1. Headers
Name	Example	Description
`Document-Store`	`invoice_store`	Document Store identifier
`Authorization`	`Bearer ha9r6DG4e5AQ84gferAd8EQ…`	Mandatory header of String type that authorizes you as the user with the right to execute this operation. The string is a Bearer Token returned from the operation create token
`Access-User`	john@company.com or john or 211555 or …	Optional header that allows to send an additional user identifier associated with the operation. May be required depending on specific document store configuration. The value is a free style string to identify the individual user who has sent the request.

Path

Table 2. Path
Name	Value	Detail
id	`qga8r5hsy9rw5weggf93lopa58`	Unique non-sequential auto-generated identifier of the document

Responses

Success

Successful responses can be easily identified being always 20x (e.g. 200, 201).

Table 3. Success response
Field	Example	Description
Status code	`200`	`OK`
`Content-Type`	`application/json`	The Content-Type entity header is used to indicate the media type of the resource. In this case, it must be `application/json`
Body	JSON response	A JSON containing the metadata of the document

JSON object

status 200

{
  "id" : "qga8r5hsy9rw5weggf93lopa58",
  "description" : "Invoice template",
  "_hidden" : false,
  "author" : "john@company.com",
  "dateCreated" : "2018-10-24T07:10:51.709Z",
  "lastModifier" : "john@company.com",
  "dateModified" : "2018-10-24T07:10:51.709Z",
  "currentVersion" : "1.0",
  "content" : [
    {
      "id" : "g8q9ppihd58art2f9op1sq28gh",
      "name" : "invoice.pdf",
      "type" : "application/pdf",
      "size" : 58943,
      "majorVersion" : 1,
      "minorVersion" : 0,
      "_hidden" : false,
      "author" : "john@company.com",
      "dateCreated" : "2018-10-24T07:10:51.709Z",
      "lastModifier" : "john@company.com",
      "dateModified" : "2018-10-26T09:15:55.980Z"
    }
  ],
  "categories" : [
    {
      "_name": "template",
      "Type": "invoice",
      "date": "2018-10-24T07:10:51.709Z",
      "boolean": true
    }
  ],
  "documentStore" : "invoice_store"
}

Table 4. Document
Name	Value	Detail
id	`qga8r5hsy9rw5weggf93lopa58`	A unique ID auto generated that identifies the document
description	`Invoice template`	A description provided by the author of the document at the creation of it
_hidden	`false`	Flag that indicates whether the document has been logically deleted or not. Only Admins can see it, and only if it is set to false, non admin users can see the document
author	`john@company.com`	The user that created the document to BigContent
dateCreated	`2018-10-24T07:10:51.709Z`	Date on which the document was uploaded. The format we follow is yyyy-MM-ddTHH:mm:ss.SSSZ. The "T" is used to separate date and time, and the Z is the zone designator for the zero UTC offset
lastModifier	`john@company.com`	The user that made the last modification to the document metadata
dateModified	`2018-10-24T07:10:51.709Z`	Date on which the document metadata was modified. The format we follow is yyyy-MM-ddTHH:mm:ss.SSSZ. The "T" is used to separate date and time, and the Z is the zone designator for the zero UTC offset
currentVersion	`1.0`	Indicates which one of the versions should be downloaded when downloading current version
content	`[{ "id" : "g8q9ppihd58art2f9op1sq28gh", "name" : "invoice.pdf", "type" : "application/pdf", "size" : 58943, "majorVersion" : 1, "minorVersion" : 0, "_hidden" : false, "author" : "john@company.com", "dateCreated" : "2018-10-24T07:10:51.709Z", "lastModifier" : "john@company.com", "dateModified" : "2018-10-26T09:15:55.980Z", }]`	Array with metadata of the associated files
categories	`[{ "_name": "template", "Type": "invoice", "date": "2018-10-24T07:10:51.709Z", "boolean": true }]`	List with all the categories assigned to this document To edit them, use add, or remove categories
documentStore	`invoice_store`	The document store in which the document is stored

Error

In case of error, the response body contains a JSON object with additional information:

span-id: auto-generated identifier of the request. Please provide this when asking for support in our forum.
message: descriptive message of the error. This is aimed for developers and is specially important for Bad Request errors., where contains hints on how to fix the request.

Error messages should not be used to validate errors since they may be subject to change.

Example

{
  "span-id" : "7eb38962-2618-85f9-brte-4f15f6729590",
  "message" : "No match found for the Id"
}

Table 5. Error messages
Status code	Message	Description include::partial$tables/error-codes.adoc[ tags= 401-token-expired; 401-token-invalid; 401-token-empty; 401-document-store; 403-document-store; 404-document-id-not-found; 500 ]

Code examples

cURL
Java
Node

curl "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58" \
-X GET \
-H "Authorization: Bearer ha9r6DG4e5AQ84gferAd8EQ..." \
-H "Document-Store: invoice_store"

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

String url = "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58";
String token = "Bearer ha9r6DG4e5AQ84gferAd8EQ...";
String documentStore = "invoice_store";

HttpGet get = new HttpGet(url);
get.setHeader("Authorization", token);
get.setHeader("Document-Store", documentStore);

CloseableHttpClient client = HttpClients.createDefault();
CloseableHttpResponse execute = client.execute(get);
HttpEntity entity = execute.getEntity();

String jsonResponse = EntityUtils.toString(entity, StandardCharsets.UTF_8);

var request = require('request');
var token = "Bearer ha9r6DG4e5AQ84gferAd8EQ...";
var documentStore = "invoice_store";

request.get({
  headers: {
    "Authorization": token,
    "Document-Store": documentStore
  },
  url: "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58",

}, function(error, response, body){
  console.log(body);
});

Update Metadata

PUT https://api.everisbigcontent.com/edms/rest/v1/metadata/{id}

Updates the metadata of the specified document.

This operation is designed to modify current values (like description), or add or modify categories, but never delete them. We ignore null values, as a safety measure, so nothing can be deleted by omission. That makes integration easier, as it only needs to be sent the value we want to modify.

For example, if we send the JSON without categories, it will not delete them. If it has a new category, it will add it. And if it contains an already present category, it will update its values.

When setting a date property, keep in mind that we accept both timestamps and date formatted strings.

The timestamp follows Unix time conventions, representing the time in milliseconds since January 1st, 1970 UTC. In case of using a string, it must adhere to the following format yyyy-MM-ddTHH:mm:ss.SSSZ. Where the T is used to separate date and time, and the Z is the zone designator for the zero UTC offset. If another offset is needed (e.g. London time), we must replace the Z by +01.

Make sure you set the correct timezone during creation or update, that is the one where the documents are created or consulted. Otherwise users may experience troubles locating documents.

For deleting a category, we have to explicitly do it using delete categories.

Parameters

HTTP Headers

HTTP headers allow pass additional information with the request or the response. BigContent headers are used for recurrent details like authentication or document store.

Table 6. Headers
Name	Example	Description
`Document-Store`	`invoice_store`	Document Store identifier
`Authorization`	`Bearer ha9r6DG4e5AQ84gferAd8EQ…`	Mandatory header of String type that authorizes you as the user with the right to execute this operation. The string is a Bearer Token returned from the operation create token
`Access-User`	john@company.com or john or 211555 or …	Optional header that allows to send an additional user identifier associated with the operation. May be required depending on specific document store configuration. The value is a free style string to identify the individual user who has sent the request.
`Content-Type`	`application/json`	The Content-Type entity header is used to indicate the media type of the resource. In this case, it must be `application/json`

Path

Table 7. Path
Name	Value	Detail
id	`qga8r5hsy9rw5weggf93lopa58`	Unique non-sequential auto-generated identifier of the document

Body

As indicated by headers, the body of the http request must be a JSON.

Metadata Example

{
  "description" : "Calendar of february",
  "categories" : [
    {
      "_name": "calendar",
      "Month": "february",
      "Year": "1998"
    }
  ]
}

Responses

Success

Successful responses can be easily identified being always 20x (e.g. 200, 201).

Table 8. Success
Field	Example	Description
Status code	`204`	`NO CONTENT`

Error

In case of error, the response body contains a JSON object with additional information:

span-id: auto-generated identifier of the request. Please provide this when asking for support in our forum.
message: descriptive message of the error. This is aimed for developers and is specially important for Bad Request errors., where contains hints on how to fix the request.

Error messages should not be used to validate errors since they may be subject to change.

Example

{
  "span-id" : "7eb38962-2618-85f9-brte-4f15f6729590",
  "message" : "No match found for the Id"
}

Table 9. Error messages
Status code	Message	Description
400	`Malformed JSON exception (line _, col _): …`	The JSON body has a bad structure. Message points where is the problem with line and column numbers as well as what is the problem (e.g. double "{", or a missing ",", …)
400	`Malformed JSON exception (line _, col _): Invalid UTF-8 middle byte…`	The encoding used to send the object was not `UTF-8`. This error can happen due to launching a curl in git-bash
400	`Category name cannot be empty or blank`	The category name is null, have blank value or was not sent
400	`Category property _ has not been defined`	The category definition with the specified name, does not have that property
400	`Category property _ is not of expected type _`	The category property type does not match the one we are sending. For example, it expects a `number` and we are sending a `String`
400	`Category property _ is mandatory`	We are not sending the value for a mandatory property
400	`Category _ not found`	No category has been found to match the `_name` specified
400	`Document cannot have duplicated categories`	The category you are trying to assign is already assigned If you want to modify it, you must delete and reassign it, or use update metadata
400	`Category property _ has value _ not found in accepted values`	The category property has a valid set of values, and the one we are sending is not valid
400	`Category property _ has an invalid date format`	The category property has a valid set of values, and the one we are sending is not valid
401	`The Token has expired on…`	Has passed more than an hour since the last create token or refresh token operation
401	`Malformed token`	The token sent is not valid
401	`Problems parsing token`	An empty token has been sent
401	`The Document-Store header must be set`	The header indicating the document store that you want to access, must be set
403	`User _ has no rights to access to the DocumentStore _`	We dont have access to that document store, or it is misspelled
404	`No match found for the Id`	The document doesn’t exists in the specified Document Store
415	`Content type _ not supported`	The Content-Type header is not correctly set
500	`Internal server error`	If it happens consistently, please report it on our forum

Code examples

cURL
Java
Node.js

curl "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58" \
-X PUT \
-H "Authorization: Bearer ha9r6DG4e5AQ84gferAd8EQ..." \
-H "Document-Store: invoice_store" \
-H 'Content-Type: application/json' \
-d '{"description" : "Calendar of february"}'

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

String url = "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58";
String token = "Bearer ha9r6DG4e5AQ84gferAd8EQ...";
String documentStore = "invoice_store";

HttpPut put = new HttpPut(url);
put.setHeader("Authorization", token);
put.setHeader("Document-Store", documentStore);

StringEntity json = new StringEntity("{\"description\":\"Calendar of february\"}");
json.setContentType(ContentType.APPLICATION_JSON.toString());

put.setEntity(json);

CloseableHttpClient client = HttpClients.createDefault();
CloseableHttpResponse execute = client.execute(put);
HttpEntity entity = execute.getEntity();

var request = require('request');
var token = "Bearer ha9r6DG4e5AQ84gferAd8EQ...";
var documentStore = "invoice_store";

request.put({
    headers: {
      "Authorization": token,
      "Document-Store": documentStore
    },
    url: "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58",
    json : {"description" : "Calendar of february"}
  }, function(error, response, body){
  console.log(body);
});

Get Categories

GET https://api.everisbigcontent.com/edms/rest/v1/metadata/{id}/categories

Retrieves the categories of the specified document.

Parameters

HTTP Headers

HTTP headers allow pass additional information with the request or the response. BigContent headers are used for recurrent details like authentication or document store.

Table 10. Headers
Name	Example	Description
`Document-Store`	`invoice_store`	Document Store identifier
`Authorization`	`Bearer ha9r6DG4e5AQ84gferAd8EQ…`	Mandatory header of String type that authorizes you as the user with the right to execute this operation. The string is a Bearer Token returned from the operation create token
`Access-User`	john@company.com or john or 211555 or …	Optional header that allows to send an additional user identifier associated with the operation. May be required depending on specific document store configuration. The value is a free style string to identify the individual user who has sent the request.

Path

Table 11. Path
Name	Value	Detail
id	`qga8r5hsy9rw5weggf93lopa58`	Unique non-sequential auto-generated identifier of the document

Responses

Success

Successful responses can be easily identified being always 20x (e.g. 200, 201).

Table 12. Success response
Field	Example	Description
Status code	`200`	`OK`
`Content-Type`	`application/json`	The Content-Type entity header is used to indicate the media type of the resource. In this case, it must be `application/json`
Body	List of JSONs	A list of JSONs containing the categories of the document

JSON response

{
  "_name": "template",
  "Type": "invoice",
  "date": "2018-10-24T07:10:51.709Z",
  "boolean": true
}

Table 13. Category
Name	Value	Detail
_name	`template`	The name of the category. It is used as the ID of the category definition
Other fields	`"Type": "invoice"`, `"date": "2018-10-24T07:10:51.709Z"`, `"boolean": true`	The name of the fields are defined in the category definition. The values of the fields are the ones defined when the category was assigned to this document

Error

In case of error, the response body contains a JSON object with additional information:

span-id: auto-generated identifier of the request. Please provide this when asking for support in our forum.
message: descriptive message of the error. This is aimed for developers and is specially important for Bad Request errors., where contains hints on how to fix the request.

Error messages should not be used to validate errors since they may be subject to change.

Example

{
  "span-id" : "7eb38962-2618-85f9-brte-4f15f6729590",
  "message" : "No match found for the Id"
}

Table 14. Error messages
Status code	Message	Description
401	`The Token has expired on…`	Has passed more than an hour since the last create token or refresh token operation
401	`Malformed token`	The token sent is not valid
401	`Problems parsing token`	An empty token has been sent
401	`The Document-Store header must be set`	The header indicating the document store that you want to access, must be set
403	`User _ has no rights to access to the DocumentStore _`	We dont have access to that document store, or it is misspelled
404	`No match found for the Id`	The document doesn’t exists in the specified Document Store
500	`Internal server error`	If it happens consistently, please report it on our forum

Code examples

cURL
Java
Node

curl "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories" \
-X GET \
-H "Authorization: Bearer ha9r6DG4e5AQ84gferAd8EQ..." \
-H "Document-Store: invoice_store"

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

String url = "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories";
String token = "Bearer ha9r6DG4e5AQ84gferAd8EQ...";
String documentStore = "invoice_store";

HttpGet get = new HttpGet(url);
get.setHeader("Authorization", token);
get.setHeader("Document-Store", documentStore);

CloseableHttpClient client = HttpClients.createDefault();
CloseableHttpResponse execute = client.execute(get);
HttpEntity entity = execute.getEntity();

String jsonResponse = EntityUtils.toString(entity, StandardCharsets.UTF_8);

System.out.println(jsonResponse);

var request = require('request');
var token = "Bearer ha9r6DG4e5AQ84gferAd8EQ...";
var documentStore = "invoice_store";

request.get({
  headers: {
    "Authorization": token,
    "Document-Store": documentStore
  },
  url: "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories",

}, function(error, response, body){
  console.log(body);
});

Add Category

POST https://api.everisbigcontent.com/edms/rest/v1/metadata/{id}/categories

Adds a category to the specified document.

The category being added must match with one of the existing category definitions for that document store. That means that a category definition must exist with the same name. It also must comply with the category definition restrictions if there are any.

When setting a date property, keep in mind that we accept both timestamps and date formatted strings.

Make sure you set the correct timezone during creation or update, that is the one where the documents are created or consulted. Otherwise users may experience troubles locating documents.

It does not update the values of the category, if adding an already present category, an error is throw. To modify a category already assigned you must delete and add it, or use Update Metadata.

Parameters

HTTP Headers

HTTP headers allow pass additional information with the request or the response. BigContent headers are used for recurrent details like authentication or document store.

Table 15. Headers
Name	Example	Description
`Document-Store`	`invoice_store`	Document Store identifier
`Authorization`	`Bearer ha9r6DG4e5AQ84gferAd8EQ…`	Mandatory header of String type that authorizes you as the user with the right to execute this operation. The string is a Bearer Token returned from the operation create token
`Access-User`	john@company.com or john or 211555 or …	Optional header that allows to send an additional user identifier associated with the operation. May be required depending on specific document store configuration. The value is a free style string to identify the individual user who has sent the request.
`Content-Type`	`application/json`	The Content-Type entity header is used to indicate the media type of the resource. In this case, it must be `application/json`

Path

Table 16. Path
Name	Value	Detail
id	`qga8r5hsy9rw5weggf93lopa58`	Unique non-sequential auto-generated identifier of the document

Body

As indicated by headers, the body of the http request must be a JSON.

Category Example

{
  "_name": "template",
  "Type": "invoice",
  "date": "2018-10-24T07:10:51.709Z",
  "boolean": true
}

Responses

Success

Successful responses can be easily identified being always 20x (e.g. 200, 201).

Table 17. Success response
Field	Example	Description
Status code	`204`	`NO CONTENT`

Error

In case of error, the response body contains a JSON object with additional information:

span-id: auto-generated identifier of the request. Please provide this when asking for support in our forum.
message: descriptive message of the error. This is aimed for developers and is specially important for Bad Request errors., where contains hints on how to fix the request.

Error messages should not be used to validate errors since they may be subject to change.

Example

{
  "span-id" : "7eb38962-2618-85f9-brte-4f15f6729590",
  "message" : "No match found for the Id"
}

Table 18. Error messages
Status code	Message	Description
400	`Malformed JSON exception (line _, col _): …`	The JSON body has a bad structure. Message points where is the problem with line and column numbers as well as what is the problem (e.g. double "{", or a missing ",", …)
400	`Malformed JSON exception (line _, col _): Invalid UTF-8 middle byte…`	The encoding used to send the object was not `UTF-8`. This error can happen due to launching a curl in git-bash
400	`Category name cannot be empty or blank`	The category name is null, have blank value or was not sent
400	`Category property _ has not been defined`	The category definition with the specified name, does not have that property
400	`Category property _ is not of expected type _`	The category property type does not match the one we are sending. For example, it expects a `number` and we are sending a `String`
400	`Category property _ is mandatory`	We are not sending the value for a mandatory property
400	`Category _ not found`	No category has been found to match the `_name` specified
400	`Document cannot have duplicated categories`	The category you are trying to assign is already assigned If you want to modify it, you must delete and reassign it, or use update metadata
400	`Category property _ has value _ not found in accepted values`	The category property has a valid set of values, and the one we are sending is not valid
400	`Category property _ has an invalid date format`	The category property has a valid set of values, and the one we are sending is not valid
401	`The Token has expired on…`	Has passed more than an hour since the last create token or refresh token operation
401	`Malformed token`	The token sent is not valid
401	`Problems parsing token`	An empty token has been sent
401	`The Document-Store header must be set`	The header indicating the document store that you want to access, must be set
403	`User _ has no rights to access to the DocumentStore _`	We dont have access to that document store, or it is misspelled
404	`No match found for the Id`	The document doesn’t exists in the specified Document Store
415	`Content type _ not supported`	The Content-Type header is not correctly set
500	`Internal server error`	If it happens consistently, please report it on our forum

Code examples

cURL
Java
Node

curl "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories" \
-X POST \
-H "Authorization: Bearer ha9r6DG4e5AQ84gferAd8EQ..." \
-H "Document-Store: invoice_store" \
-H 'Content-Type:application/json' \
-d '{"_name" : "calendar", "Month": "february", "Year": "1998"}'

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

String category = "{\"_name\" : \"calendar\", \"Month\": \"february\", \"Year\": \"1998\"}";

String url = "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories";
String token = ha9r6DG4e5AQ84gferAd8EQ...;
String documentStore = "invoice_store";

HttpPost post = new HttpPost(url);
post.setHeader("Authorization", "Bearer " + token);
post.setHeader("Document-Store", documentStore);

StringEntity json = new StringEntity(category);
json.setContentType(ContentType.APPLICATION_JSON.toString());

post.setEntity(json);

CloseableHttpClient client = HttpClients.createDefault();
CloseableHttpResponse execute = client.execute(post);

var request = require('request');
var token = "ha9r6DG4e5AQ84gferAd8EQ...";
var documentStore = "invoice_store";

request.post({
  headers: {
    "Authorization": "Bearer " + token,
    "Document-Store": documentStore,
    'Content-Type': 'application/json',
  },
  url: "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories",
  json: {
    "_name" : "calendar",
    "Month": "february",
    "Year": "1998"
  }
}, function (error, response, body) {
});

Delete Categories

DELETE https://api.everisbigcontent.com/edms/rest/v1/metadata/{id}/categories/{CATEGORY_NAME}

Deletes a category from the specified document.

Parameters

HTTP Headers

HTTP headers allow pass additional information with the request or the response. BigContent headers are used for recurrent details like authentication or document store.

Table 19. Headers
Name	Example	Description
`Document-Store`	`invoice_store`	Document Store identifier
`Authorization`	`Bearer ha9r6DG4e5AQ84gferAd8EQ…`	Mandatory header of String type that authorizes you as the user with the right to execute this operation. The string is a Bearer Token returned from the operation create token
`Access-User`	john@company.com or john or 211555 or …	Optional header that allows to send an additional user identifier associated with the operation. May be required depending on specific document store configuration. The value is a free style string to identify the individual user who has sent the request.

Path

Table 20. Path
Name	Value	Detail
id	`qga8r5hsy9rw5weggf93lopa58`	Unique non-sequential auto-generated identifier of the document
category_name	`policyDefinition`	The name of the category definition, which is used as a unique identifier

Responses

Success

Successful responses can be easily identified being always 20x (e.g. 200, 201).

Table 21. Success response
Field	Example	Description
Status code	`204`	`NO CONTENT`

Error

In case of error, the response body contains a JSON object with additional information:

span-id: auto-generated identifier of the request. Please provide this when asking for support in our forum.
message: descriptive message of the error. This is aimed for developers and is specially important for Bad Request errors., where contains hints on how to fix the request.

Error messages should not be used to validate errors since they may be subject to change.

Example

{
  "span-id" : "7eb38962-2618-85f9-brte-4f15f6729590",
  "message" : "No match found for the Id"
}

Table 22. Error messages
Status code	Message	Description
401	`The Token has expired on…`	Has passed more than an hour since the last create token or refresh token operation
401	`Malformed token`	The token sent is not valid
401	`Problems parsing token`	An empty token has been sent
401	`The Document-Store header must be set`	The header indicating the document store that you want to access, must be set
403	`User _ has no rights to access to the DocumentStore _`	We dont have access to that document store, or it is misspelled
404	`No match found for the Id`	The document doesn’t exists in the specified Document Store
500	`Internal server error`	If it happens consistently, please report it on our forum

Code examples

cURL
Java
Node

curl "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories/calendar" \
-X DELETE \
-H "Authorization: Bearer ha9r6DG4e5AQ84gferAd8EQ..." \
-H "Document-Store: invoice_store"

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

String url = "https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories/calendar;
String token = "ha9r6DG4e5AQ84gferAd8EQ...";
String documentStore = "invoice_store";

HttpDelete delete = new HttpDelete(url);
delete.setHeader("Authorization", "Bearer " + token);
delete.setHeader("Document-Store", documentStore);

CloseableHttpClient client = HttpClients.createDefault();
CloseableHttpResponse execute = client.execute(delete);

var request = require('request');
var token = ha9r6DG4e5AQ84gferAd8EQ...;
var documentStore = invoice_store;
request.delete({
  headers: {
    "Authorization": "Bearer " + token,
    "Document-Store": documentStore
  },
  url: 'https://api.everisbigcontent.com/edms/rest/v1/metadata/qga8r5hsy9rw5weggf93lopa58/categories/calendar"
}, function (error, response, body) {
});