Service Handshake

Queries the availability of the Document Entity service.

Request

Method Type:

GET

URI:

/rest/serverengine/entity/documents

Content: –
Content Type:

–

Add. Headers:

If server security settings are enabled, then one of the following:

  • Authorization – Basic Authentication (Username and Password) credentials (Base64 encoded)
  • auth_token – Authorization Token

Response

Success

The following lists status codes indicative of a successful response:

Status Code Content Content-Type Add. Headers Description
200
OK		 Handshake message:
Server Engine REST Service available: DocumentEntityRestService 		text/plain – REST Service available

Error

The following lists status codes indicative of a failed or error response:

Status Code Content Content-Type Add. Headers Description

401 Unauthorized

–

–

WWW-Authenticate – BASIC (Basic Authentication credentials are accepted)

Server authentication is required.

Response when neither basic authentication credentials nor an authorization token have been specified in the request headers.

401 Unauthorized

Error message

–

–

Server authentication has failed.

Response when the authorization token specified in the request headers has now expired.

403 Forbidden

Error message

–

–

Server authentication has failed.

Response when either the basic authentication credentials or the authorization token specified in the request headers are invalid.