Skip to main content

Fetch Design

Retrieve customer design data with support for hierarchy filtering.
Returns design data that can be filtered by various hierarchy levels including country, site, field, well, and wellbore.

GET/api/design/customer

Retrieves customer design data. Can be filtered by hierarchy levels or specific field values.

Parameters

NameTypeRequiredDescription
fieldstring-The field to filter by (e.g., 'wellbore', 'well', 'field', 'site', 'country', 'uwi', 'apiNo')
valuestring-The value to match for the specified field

Notes

  • When called without parameters, returns all customer design data accessible to the authenticated user
  • Supports filtering by hierarchy levels: country, site, field, well, wellbore
  • Additional filter fields uwi and apiNo will be available after hierarchyms deployment
  • The field and value parameters must be used together - providing only one will result in an error
  • Each design includes complete hierarchy information showing the relationship between country, site, field, well, and wellbore
  • The response includes a totalCount field indicating the number of designs returned
  • When filtered, the response includes a filteredBy object showing the applied filter criteria