NOV WellData

Methods (42)

• getJobs

  read

  List all jobs (wells) with filtering and sorting.

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "take": {
        "type": "number"
      },
      "skip": {
        "type": "number"
      },
      "sort": {
        "type": "string"
      },
      "total": {
        "type": "boolean"
      }
    },
    "additionalProperties": false
  }

• getJob

  read

  Get job details by ID (NOV WellData).

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getAlarmEvents

  read

  Get alarm events for a job.

  Required paramsjobId

  Entitiesincident
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "take": {
        "type": "number"
      },
      "skip": {
        "type": "number"
      },
      "sort": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getAlarmConfigurations

  read

  Get alarm configurations for a job.

  Required paramsjobId

  Entitiesincident
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "take": {
        "type": "number"
      },
      "skip": {
        "type": "number"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getMudPumps

  read

  Get mud pump data for a job.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getRigs

  read

  Get rig data for a job.

  Required paramsjobId

  Entitiesrig
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getAttributes

  read

  Get all attributes (channels) for a job.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getCalculatedAttributes

  read

  Get calculated attributes for a job.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getRoadmapAttributes

  read

  Get roadmap attributes for a job.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getConfigurations

  read

  Get all configurations for a job.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getTimeData

  read

  Get historical time series data.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getCurrentTimeData

  read

  Get last known real-time values.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getTimeEvents

  read

  Get events over a time range.

  Required paramsjobIdbody

  Entitiesincident
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getTimeSummary

  read

  Get time summary for an attribute (NOV WellData).

  Required paramsjobIdattributeId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "attributeId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "attributeId"
    ]
  }

• getDepthData

  read

  Get historical depth-indexed data.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getConnections

  read

  Get connection time data.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getSurveys

  read

  Get directional surveys (NOV WellData).

  Required paramsjobId

  Entitiessurvey
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "take": {
        "type": "number"
      },
      "skip": {
        "type": "number"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getCurrentSurvey

  read

  Get current real-time survey.

  Required paramsjobId

  Entitiessurvey
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getSurveyModels

  read

  Get survey correction models.

  Required paramsjobId

  Entitiessurvey
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getFormations

  read

  Get formation tops data (NOV WellData).

  Required paramsjobId

  Entitiesformation
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getRuns

  read

  Get all runs for a job.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getBhas

  read

  Get BHA (Bottom Hole Assembly) data (NOV WellData).

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getCasings

  read

  Get casing string data.

  Required paramsjobId

  Entitiescompletion
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getSections

  read

  Get well sections.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getSwabSurgeData

  read

  Get swab/surge EMW data.

  Required paramsjobIdrunIdswabSurgeType

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "runId": {
        "type": "string"
      },
      "swabSurgeType": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "runId",
      "swabSurgeType"
    ]
  }

• getTripSpeedModel

  read

  Get trip speed swab/surge model.

  Required paramsjobIdrunIdswabSurgeTypebody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "runId": {
        "type": "string"
      },
      "swabSurgeType": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "runId",
      "swabSurgeType",
      "body"
    ]
  }

• getMudChecks

  read

  Get mud check data.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getNotes

  read

  Get well notes.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "take": {
        "type": "number"
      },
      "skip": {
        "type": "number"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• createNote

  write

  Create a note on a job.

  Required paramsjobIddata

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "data": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "data"
    ]
  }

• getNoteChanges

  read

  Stream real-time note changes.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getTorqueDragData

  read

  Get torque & drag run data.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getTorqueDragModel

  read

  Get torque & drag model.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getPressureModels

  read

  Get pressure models.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getSegments

  read

  Get well segments.

  Required paramsjobId

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• getReportClassifications

  read

  List available report types.

  Entitiesdocument
  Input schema

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

• getSummaryReports

  read

  Get summary reports.

  Entitiesdocument
  Input schema

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

• getNextReport

  read

  Get the next queued report.

  Entitiesdocument
  Input schema

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

• getUploadedFiles

  read

  List uploaded files for a job.

  Required paramsjobId

  Entitiesdocument
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      }
    },
    "additionalProperties": false,
    "required": [
      "jobId"
    ]
  }

• exportTimeDelimited

  read

  Export time data as delimited file.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• exportDepthDelimited

  read

  Export depth data as delimited file.

  Required paramsjobIdbody

  Entitiesrecord
  Input schema

  {
    "type": "object",
    "properties": {
      "jobId": {
        "type": "string"
      },
      "body": {}
    },
    "additionalProperties": false,
    "required": [
      "jobId",
      "body"
    ]
  }

• getCurrentUser

  read

  Get current authenticated user.

  Entitiesrecord
  Input schema

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

• getUnitDefinitions

  read

  Get unit of measure definitions.

  Entitiesunit, lease
  Input schema

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