Overview

Overview

Documaster Noark5 API is an HTTP/JSON based API, secured with OAuth2/OIC. As such all requests and responses, apart from those for uploading and downloading files are in JSON format (having Content-Type: application/json).

Documaster Noark 5 API exposes operations for managing all the archive core entities, together with operations for managing business specific metadata (BSM), code lists, etc. Core entities are managed through the Core Operations, while any other entities are managed using Other Operations.

Security

All operations are secured using OAuth2/OIC, which means an access token should be provided in the Authorizaton HTTP header prefixed with Bearer. For more details please refere to Authentication and Authorization section.

HTTP Status Codes

All operations return an HTTP status code in the 2XX range when successfully executed. Below are the supported successful status codes.

Number of HTTP status codes are supported to indicate an error either on the server side or the client side. HTTP status codes for errors are separated in groups depending on when they can occur.

Integration Error HTTP Status Codes

Integration error codes are HTTP status codes that are most likely to be seen during the integration phace with the API. Those are codes indicating that the request being made is invalid and should be corrected. Observing those error codes in production integration can be considered an indicator of incorrect usage of the API.

Operational Error HTTP Status Codes

Errors

All operations return errors in JSON format. Mandatory request header X-Documaster-Error-Response-Type set to application/json explicitly instructs the API to return only JSON formed responses.

Error Format

Sample error JSON response message looks like the sample below.

{
    "errorId": "3aa5618a-13fb-4c96-9446-26ad6e98e5b5",
    "description": "A field with name 1eksterntSystem was not found in EksternId or its hierarchy.",
    "status": 400
}