IHS Energy

Methods (12)

• listDomains

  read

  List available IHS API domains.

  Entitiesmetadata
  Input schema

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

• listOperations

  read

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

  Entitiesmetadata
  Input schema

  {
    "type": "object",
    "properties": {
      "tag": {
        "type": "string",
        "examples": [
          "Upstream Intelligence"
        ]
      },
      "method": {
        "type": "string"
      },
      "pathPrefix": {
        "type": "string"
      },
      "text": {
        "type": "string"
      }
    },
    "additionalProperties": false
  }

• describeOperation

  read

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

  Required paramsoperationId

  Entitiesmetadata
  Input schema

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

• request

  unknown

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

  Entitiesrequest
  Input schema

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

• listViews

  read

  List available views for a domain

  Required paramsdomain

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "examples": [
          "northamerica/midstream"
        ]
      },
      "format": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "domain"
    ]
  }

• getViewSchema

  read

  Get column metadata for a view (IHS Energy).

  Required paramsdomainview

  Entitiesmetadata
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "examples": [
          "adm/eandp"
        ]
      },
      "view": {
        "type": "string",
        "examples": [
          "Wells"
        ]
      },
      "format": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "domain",
      "view"
    ]
  }

• retrieve

  read

  Retrieve records from a named IHS data view.

  Required paramsdomainview

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "examples": [
          "adm/eandp"
        ],
        "description": "IHS data domain."
      },
      "view": {
        "type": "string",
        "examples": [
          "Wells"
        ],
        "description": "View name."
      },
      "filter": {
        "type": "string",
        "examples": [
          "country_name eq 'Brazil'"
        ],
        "description": "OData filter expression."
      },
      "select": {
        "type": "string"
      },
      "count": {
        "type": "number",
        "examples": [
          10
        ],
        "description": "Maximum records to return."
      },
      "start_index": {
        "type": "number"
      },
      "orderby": {
        "type": "string"
      },
      "groupby": {
        "type": "string"
      },
      "having": {
        "type": "string"
      },
      "geometry": {
        "type": "string"
      },
      "format": {
        "type": "string"
      },
      "method": {
        "type": "string",
        "examples": [
          "POST"
        ],
        "oneOf": [
          {
            "type": "string",
            "enum": [
              "POST"
            ]
          },
          {
            "type": "string",
            "enum": [
              "GET"
            ]
          }
        ],
        "description": "HTTP method, usually GET or POST."
      },
      "query": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      },
      "body": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "additionalProperties": true,
    "required": [
      "domain",
      "view"
    ]
  }

• count

  read

  Count records in a view without retrieving the full dataset.

  Required paramsdomainview

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "examples": [
          "adm/eandp"
        ],
        "description": "IHS data domain."
      },
      "view": {
        "type": "string",
        "examples": [
          "Wells"
        ],
        "description": "View name."
      },
      "filter": {
        "type": "string",
        "description": "OData filter expression."
      },
      "format": {
        "type": "string"
      },
      "method": {
        "oneOf": [
          {
            "type": "string",
            "enum": [
              "POST"
            ]
          },
          {
            "type": "string",
            "enum": [
              "GET"
            ]
          }
        ],
        "type": "string",
        "description": "HTTP method, usually GET or POST."
      },
      "body": {
        "type": "object",
        "properties": {},
        "additionalProperties": true
      }
    },
    "additionalProperties": true,
    "required": [
      "domain",
      "view"
    ]
  }

• getSessions

  read

  Get active session details and entitlements

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "verbose": {
        "type": "boolean",
        "examples": [
          true
        ]
      }
    },
    "additionalProperties": false
  }

• deleteSessions

  write

  Delete active sessions for the current credentials

  Entitiesrecord
  Input schema

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

• getReports

  read

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

  Required paramsdomain

  Entitiesdocument
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "examples": [
          "adm/eandp"
        ]
      },
      "reportType": {
        "type": "string"
      },
      "id": {
        "type": "string"
      },
      "format": {
        "type": "string"
      },
      "includeLocationMaps": {
        "type": "boolean"
      },
      "includeGraphs": {
        "type": "boolean"
      },
      "includeImages": {
        "type": "boolean"
      },
      "idType": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "domain"
    ]
  }

• getImage

  read

  Get images for a view entity

  Required paramsdomainviewid

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "domain": {
        "type": "string",
        "examples": [
          "adm/eandp"
        ]
      },
      "view": {
        "type": "string",
        "examples": [
          "Wells"
        ]
      },
      "id": {
        "type": "string",
        "examples": [
          "12345"
        ]
      },
      "format": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "domain",
      "view",
      "id"
    ]
  }