Field Select

Introduction

Field select is a new MediaHaven REST API feature that when searching or retrieving a record allows for specifying a set of dotted keys of https://mediahaven.atlassian.net/wiki/spaces/CS/pages/2703949892, such that the API returns for the requested record(s) only the corresponding https://mediahaven.atlassian.net/wiki/spaces/CS/pages/42074134.

Specification

The https://mediahaven.atlassian.net/wiki/spaces/CS/pages/42074134 to return are specified by joining the sets of the dotted keys provided by

• All the fields linked with the explicitly providedhttps://mediahaven.atlassian.net/wiki/spaces/CS/pages/3273949212

• An explicit set of dotted keys

API Contract

API methods that return records now accept additional parameters/properties

1. profiles Optional set of profile IDs

2. fields Optional set of fields specified as dotted key

The following methods support this (non-exhaustive list)

• GET /records → https://integration.mediahaven.com/mediahaven-rest-api/v2/api-docs/index.html#mediahaven-rest-api-manual-search-for-records-basic-searching

• GET /records/:recordID → https://integration.mediahaven.com/mediahaven-rest-api/v2/api-docs/index.html#mediahaven-rest-api-manual-search-for-records-getting-a-specific-record

Benefits

The major benefit of using field select is performance and throughput as

• It reduces the load on the underlying search engine by requesting less metadata and hence improves the general responsiveness of the search engine

• It reduces the API response time because the underlying search engine returns results much faster and reduces JSON processing times

• It reduces the size of returned metadata and hence the download time of the API response