Find Data Entity

Submits data entity search criteria to the OL Connect Server.

Request takes a JSON Search Parameters structure as content and on success returns a response containing JSON Identifier Lists (with Sort Key) of the data entity IDs matching the search criteria.

Method Type:

PUT

URI:

/rest/serverengine/entity/find

Content: JSON Search Parameters containing search criteria/rules
Content Type:

application/json

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		 JSON Identifier Lists (with Sort Key) containing all the entities matching the search criteria application/json – Search request successfully executed

Error

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

Status Code Content Content-Type Add. Headers Description

401 Unauthorized

JSON Error specifying error message

application/json

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

Server authentication has failed.

Response when either:

  • basic authentication credentials nor an authorization token have been specified in the request headers

  • the basic authentication credentials or the authorization token specified in the request headers are invalid

  • the authorization token specified in the request headers has now expired

403 Forbidden

JSON Error specifying error message

application/json

–

Server authentication has succeeded, but user authorization for this specific method has failed.

Response when authentication of the credentials or the authorization token specified in the request headers has succeeded, but the user associated with the credentials or the authorization token specified has insufficient role assignment/privileges.

500
Internal Server Error

JSON Error specifying error message

application/json

–

 Server error or Invalid JSON structure specified