Search ReST API Request

Send the data source request via the Web API proxy server for search operations.

This function is how client-side applications can cross-entity search server-side ReST API requests without having to know about security credentials.

This specific ReST API CRUD operation is designed for searching across all entities only.

Send App Studio Data Source Request

POST Lookup/Find

This is a POST method which passes both the API and session keys as headers, and a body. If successful, the custom data sources can be stored.

Headers

Name
Value

Content-Type

application/json

SiteKey

API Key

DataServicesKey

Session Key

Body

Name
Type
Description

Expression

String

The text used to search over all entities e.g. "Dan".

MaximumRecordsPerEntity

Number

The maximum number of records to return.

RequestId

String

The data source request ID of the specific cross-entity search ReST API.

Response Snippet

{
  "Success": true,
  "ErrorMessage": null,
  "Items": [
        {
            "EntityName": "Footballer",
            "Display": "Dan Burn, Defender",
            "EntityID": "67fe29f678badf650005d3ee"
        },
        {
            "EntityName": "Footballer",
            "Display": "Danny Ings, Forward",
            "EntityID": "6863ef6c78badf6500137eec"
        },
        {
            "EntityName": "Nationality",
            "Display": "Denmark",
            "EntityID": "6863f5f478badf650013800d"
        }
    ]
}

Entity Name

This should be the name of the form in the application configuration so that the client-side app can obtain the form icon to display.

Display

This is the text to display in the client-side app for each result.

EntityID

This is the unique identifier of the record returned. If the end-user clicks this item, the client-side app should then be able to open the matching form record.

Response Example

This is how this example response could like in a client-side app:

PreviousSend ReST API RequestNextSummary

Last updated