smda

Retrieves masterdata for fields to be confirmed in the GUI

A route to gather prospective SMDA masterdata relevant to FMU.

This route receives a list of valid field names and returns masterdata that pertains to them. The field names should be valid as returned from the smda/field route. Callers may also provide a field UUID to disambiguate fields that share the same identifier. If the first field does not include a UUID, the endpoint searches for all provided field identifiers. If the first field includes a UUID, the endpoint looks up only that field, even if more fields are included in the request.

The data returned from this endpoint is meant to be confirmed by the user who may need to do some additional selection or pruning based upon the model they are working from.

One example of this is changing the coordinate system. A model may use a coordinate system different from the one set as the field's default coordinate system in SMDA. To match the way this works on SMDA, every coordinate system known to SMDA is returned.

This endpoint does multiple calls to the SMDA API, any of which may possibly fail. In any of these calls fails incomplete data will not be returned; that is, a successful code with partial data will not be returned.

post/api/v1/smda/masterdata

Request

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

Cookies

fmu_settings_sessionstring nullable

Request body

identifierstring required

A field identifier (name).

uuidstring uuid nullable

The SMDA UUID identifier corresponding to the field identifier.

Example request

[
  {
    "identifier": "TROLL"
  }
]

Response

Successful Response

Example response

{
  "field": [
    {
      "identifier": "OseFax",
      "uuid": "15ce3b84-766f-4c93-9050-b154861f9100"
    }
  ],
  "country": [
    {
      "identifier": "Norway",
      "uuid": "15ce3b84-766f-4c93-9050-b154861f9100"
    }
  ],
  "discovery": [
    {
      "short_identifier": "SomeDiscovery",
      "uuid": "15ce3b84-766f-4c93-9050-b154861f9100"
    }
  ],
  "stratigraphic_columns": [
    {
      "identifier": "DROGON_2020",
      "uuid": "15ce3b84-766f-4c93-9050-b154861f9100"
    }
  ],
  "field_coordinate_system": {
    "identifier": "ST_WGS84_UTM37N_P32637",
    "uuid": "15ce3b84-766f-4c93-9050-b154861f9100"
  },
  "coordinate_systems": [
    {
      "identifier": "ST_WGS84_UTM37N_P32637",
      "uuid": "15ce3b84-766f-4c93-9050-b154861f9100"
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.