IHS Energy

Methods (12)

• listDomains

  read

  List available IHS API domains.

  Input schema

  {
    "type": "object",
    "properties": {},
    "additionalProperties": true
  }

• listOperations

  read

  List Swagger operations with optional tag, text, path, and method filters

• describeOperation

  read

  Inspect the request shape for a domain operation before calling it.

  Required paramsoperationId
  Input schema

  {
    "type": "object",
    "properties": {
      "operationId": {
        "type": "string",
        "description": "Swagger operation ID."
      }
    },
    "required": [
      "operationId"
    ],
    "additionalProperties": true
  }

• request

  unknown

  Execute any published IHS operation by operationId or explicit path/method.

  Input schema

  {
    "type": "object",
    "properties": {
      "operationId": {
        "type": "string",
        "description": "Swagger operation ID."
      },
      "path": {
        "type": "string",
        "description": "Explicit request path override."
      },
      "method": {
        "type": "string",
        "description": "HTTP method override."
      },
      "pathParams": {
        "type": "object",
        "description": "Path parameter values."
      },
      "query": {
        "type": "object",
        "description": "Query string parameters."
      },
      "body": {
        "type": "object",
        "description": "Request body payload."
      }
    },
    "additionalProperties": true
  }

• listViews

  read

  List available views for a domain

  Required paramsdomain

• getViewSchema

  read

  Get column metadata for a view

  Required paramsdomainview

• retrieve

  read

  Retrieve records from a named IHS data view.

  Required paramsdomainview
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "description": "IHS data domain."
      },
      "view": {
        "type": "string",
        "description": "View name."
      },
      "filter": {
        "type": "string",
        "description": "OData filter expression."
      },
      "count": {
        "type": "number",
        "description": "Maximum records to return."
      },
      "method": {
        "type": "string",
        "description": "HTTP method, usually GET or POST."
      }
    },
    "required": [
      "domain",
      "view"
    ],
    "additionalProperties": true
  }

• count

  read

  Count records in a view without retrieving the full dataset.

  Required paramsdomainview
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "description": "IHS data domain."
      },
      "view": {
        "type": "string",
        "description": "View name."
      },
      "filter": {
        "type": "string",
        "description": "OData filter expression."
      },
      "method": {
        "type": "string",
        "description": "HTTP method, usually GET or POST."
      }
    },
    "required": [
      "domain",
      "view"
    ],
    "additionalProperties": true
  }

• getSessions

  read

  Get active session details and entitlements

• deleteSessions

  write

  Delete active sessions for the current credentials

• getReports

  read

  List or retrieve reports (adm/basin, adm/eandp)

  Required paramsdomain

• getImage

  read

  Get images for a view entity

  Required paramsdomainviewid