smda

Searches for a field identifier in SMDA

A route to search SMDA for a field (asset) by its named identifier.

This endpoint applies a projection to the SMDA query so that only the relevant data is returned: an identifier known by SMDA, its corresponding UUID, and the main country the field belongs to, not a list of countries where the field exists. The UUID should be used by other endpoints required the collection of data by a field, i.e. this route is a dependency for most other routes.

The number of results (hits) and number of pages those results span over is also returned in the result. This endpoint does not implement pagination. The current expectation is that a user would refine their search rather than page through different results.

post/api/v1/smda/field

Request

  • The document declares no server URL.
  • Auth: none declared

Cookies

fmu_settings_sessionstring nullable

Request body

identifierstring required

A field identifier (name).

Example request

{
  "identifier": "TROLL"
}

Response

Successful Response

hitsinteger required

The number of hits from the field search.

pagesinteger required

The number of pages of hits.

Example response

{
  "results": [
    {
      "identifier": "TROLL"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.