Sign up
All data sources

NOV WellData

Premium

Query your NOV WellData drilling jobs: time and depth data, surveys, and alarms.

oil-and-gas
Try NOV WellData free for 14 daysGet the full contract and schemas as JSONConnect this source →

Premium: 14-day free trial with your NOV WellData key, then Professional ($500/user/mo).

Questions you can ask

  • “Which drilling jobs are in our WellData account?”
  • “Show the latest survey for this job.”
  • “Pull bit depth and rate of penetration for the last 12 hours on this job.”
Sample outputfor “Pull bit depth and rate of penetration for the last 12 hours on this job.”
TimeBit depth (ft)ROP (ft/hr)
06:0011,24092
08:0011,41085
10:0011,56078

Illustrative values showing the shape of an answer, not live data.

About this source

NOV WellData — 182 exact model-callable operations generated from the official 183-operation Swagger. Covers jobs, assets, time/depth data, surveys, BHAs, casings, formations, models, alarms, reports, files, metadata, and provider capabilities. RULES: 1. Auth bootstrap is internal and excluded from the model surface. 2. Exact methods use the official operation ID prefixed with "official". 3. Mutating POST/PUT/DELETE operations require action approval. 4. Every input schema is closed and derived from the pinned official Swagger.

Connector ID welldata

Provenance

PublisherNOV WellData
API basehttps://data.welldata.net/api/v1

Freshness & coverage

FreshnessFreshness not declared
GeographicNot declared
TemporalNot declared
AuthenticationCredentials required (API key)

› Methods (182)

Technical detail for developers: parameters, pagination, units, and freshness per method.

  • officialGetAssets

    read

    GET /api/v1/assets

    Entitiesassets
    • ⚠ Official Swagger operation FacadeServiceV1_GetAssets: GET /api/v1/assets.

  • officialGetAssetsCapabilities

    read

    Fetches the capabilities of the assets endpoint

    Entitiesassets
    • ⚠ Official Swagger operation FacadeServiceV1_GetAssetsCapabilities: GET /api/v1/assets/capabilities.

  • officialGetAssetById

    read

    GET /api/v1/assets/{assetId}

    Required paramsassetId
    Entitiesassets
    • ⚠ Official Swagger operation FacadeServiceV1_GetAssetById: GET /api/v1/assets/{assetId}.

  • officialGetAssetCapabilitiesById

    read

    Fetches the capabilities of an asset

    Required paramsassetId
    Entitiesassets
    • ⚠ Official Swagger operation FacadeServiceV1_GetAssetCapabilitiesById: GET /api/v1/assets/{assetId}/capabilities.

  • officialGetJobsByAssetId

    read

    GET /api/v1/assets/{assetId}/jobs

    Required paramsassetId
    Entitiesassets
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobsByAssetId: GET /api/v1/assets/{assetId}/jobs.

  • officialGetJobsCapabilitiesByAssetId

    read

    Fetches the capabilities of the jobs by asset endpoint

    Required paramsassetId
    Entitiesassets
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobsCapabilitiesByAssetId: GET /api/v1/assets/{assetId}/jobs/capabilities.

  • officialGetJobs

    read

    Fetches all jobs

    Entitiesjobs
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobs: GET /api/v1/jobs.

  • officialGetJobsCapabilities

    read

    Fetches the capabilities of the jobs endpoint

    Entitiesjobs
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobsCapabilities: GET /api/v1/jobs/capabilities.

  • officialGetJobById

    read

    Fetches a job by its id

    Required paramsjobId
    Entitiesjobs
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobById: GET /api/v1/jobs/{jobId}.

  • officialGetAlarmConfigurations

    read

    Fetches alarm change log for a single job

    Required paramsjobId
    Entitiesalarmconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_GetAlarmConfigurations: GET /api/v1/jobs/{jobId}/alarm-configurations.

  • officialGetAlarmConfigurationsCapabilities

    read

    Fetches the capabilities for the alarm configurations specified by the Job ID.

    Required paramsjobId
    Entitiesalarmconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_GetAlarmConfigurationsCapabilities: GET /api/v1/jobs/{jobId}/alarm-configurations/capabilities.

  • officialGetAlarmEvents

    read

    Fetches alarm events for a single job

    Required paramsjobId
    Entitiesalarmevents
    • ⚠ Official Swagger operation FacadeServiceV1_GetAlarmEvents: GET /api/v1/jobs/{jobId}/alarm-events.

  • officialGetAlarmsCapabilities

    read

    Fetches the alarms events capabilities for a single job

    Required paramsjobId
    Entitiesalarmevents
    • ⚠ Official Swagger operation FacadeServiceV1_GetAlarmsCapabilities: GET /api/v1/jobs/{jobId}/alarm-events/capabilities.

  • officialGetMudPumps

    read

    GetMudPumps gets all the mud pumps and properties for the specified Job ID

    Required paramsjobId
    Entitiesmudpumps
    • ⚠ Official Swagger operation FacadeServiceV1_GetMudPumps: GET /api/v1/jobs/{jobId}/assets/mud-pumps.

  • officialCreateOrUpdateMudPumps

    write

    PUT /api/v1/jobs/{jobId}/assets/mud-pumps

    Required paramsjobIdbody
    Entitiesmudpumps
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateMudPumps: PUT /api/v1/jobs/{jobId}/assets/mud-pumps.

  • officialDeleteMudPumps

    write

    DELETE /api/v1/jobs/{jobId}/assets/mud-pumps

    Required paramsjobIdsourcemudPumpId
    Entitiesmudpumps
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteMudPumps: DELETE /api/v1/jobs/{jobId}/assets/mud-pumps.

  • officialGetMudPumpsCapabilities

    read

    GetMudPumpsCapabilities fetches the capabilities for the mud pumps and properties specified by…

    Required paramsjobId
    Entitiesmudpumps
    • ⚠ Official Swagger operation FacadeServiceV1_GetMudPumpsCapabilities: GET /api/v1/jobs/{jobId}/assets/mud-pumps/capabilities.

  • officialGetRigs

    read

    GetRigs gets all the Rigs for a specified jobId

    Required paramsjobId
    Entitiesrigs
    • ⚠ Official Swagger operation FacadeServiceV1_GetRigs: GET /api/v1/jobs/{jobId}/assets/rigs.

  • officialCreateOrUpdateRigs

    write

    CreateRigs creates Rigs for a specified jobId

    Required paramsjobIdbody
    Entitiesrigs
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateRigs: PUT /api/v1/jobs/{jobId}/assets/rigs.

  • officialDeleteRigs

    write

    DeleteRigs deletes the Rigs for a specified jobId

    Required paramsjobIdsourcerigId
    Entitiesrigs
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteRigs: DELETE /api/v1/jobs/{jobId}/assets/rigs.

  • officialGetRigsCapabilities

    read

    GetRigsCapabilities fetches the capabilities for Rigs for a specified jobID

    Required paramsjobId
    Entitiesrigs
    • ⚠ Official Swagger operation FacadeServiceV1_GetRigsCapabilities: GET /api/v1/jobs/{jobId}/assets/rigs/capabilities.

  • officialGetAttributes

    read

    Fetches the attributes for a single job

    Required paramsjobId
    Entitiesattributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetAttributes: GET /api/v1/jobs/{jobId}/attributes.

  • officialGetCalculatedAttributes

    read

    Fetches the calculated attributes for a job

    Required paramsjobId
    Entitiescalculated attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetCalculatedAttributes: GET /api/v1/jobs/{jobId}/attributes/calculated.

  • officialCreateCalculatedAttribute

    write

    Creates a new calculated attribute

    Required paramsjobIdconfiguration
    Entitiescalculated attributes
    • ⚠ Official Swagger operation FacadeServiceV1_CreateCalculatedAttribute: PUT /api/v1/jobs/{jobId}/attributes/calculated.

  • officialGetCalculatedAttributesCapabilities

    read

    Fetches the calculated attributes capabilities for a job

    Required paramsjobId
    Entitiescalculated attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetCalculatedAttributesCapabilities: GET /api/v1/jobs/{jobId}/attributes/calculated/capabilities.

  • officialGetCalculatedAttributeConstants

    read

    Fetches the calculated attribute constants for a job

    Required paramsjobId
    Entitiescalculated attribute constants
    • ⚠ Official Swagger operation FacadeServiceV1_GetCalculatedAttributeConstants: GET /api/v1/jobs/{jobId}/attributes/calculated/constants.

  • officialCreateCalculatedAttributeConstant

    write

    Creates a new calculated attribute constant

    Required paramsjobIdconstant
    Entitiescalculated attribute constants
    • ⚠ Official Swagger operation FacadeServiceV1_CreateCalculatedAttributeConstant: PUT /api/v1/jobs/{jobId}/attributes/calculated/constants.

  • officialGetCalculatedAttributeConstantsCapabilities

    read

    Fetches the calculated attribute constants capabilities for a job

    Required paramsjobId
    Entitiescalculated attribute constants
    • ⚠ Official Swagger operation FacadeServiceV1_GetCalculatedAttributeConstantsCapabilities: GET /api/v1/jobs/{jobId}/attributes/calculated/constants/capabilities.

  • officialDeleteCalculatedAttributeConstant

    write

    Deletes a calculated attribute constant

    Required paramsjobIdname
    Entitiescalculated attribute constants
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteCalculatedAttributeConstant: DELETE /api/v1/jobs/{jobId}/attributes/calculated/constants/{name}.

  • officialGetCalculatedAttributeConstantByNameCapabilities

    read

    Fetches the calculated attribute constants capabilities for a job

    Required paramsjobIdname
    Entitiescalculated attribute constants
    • ⚠ Official Swagger operation FacadeServiceV1_GetCalculatedAttributeConstantByNameCapabilities: GET /api/v1/jobs/{jobId}/attributes/calculated/constants/{name}/capabilities.

  • officialUpdateCalculatedAttributeConstant

    write

    Updates a calculated attribute constant

    Required paramsjobIdoldNameconstant
    Entitiescalculated attribute constants
    • ⚠ Official Swagger operation FacadeServiceV1_UpdateCalculatedAttributeConstant: PUT /api/v1/jobs/{jobId}/attributes/calculated/constants/{oldName}.

  • officialUpdateCalculatedAttribute

    write

    Updates a calculated attribute

    Required paramsjobIdidconfiguration
    Entitiescalculated attributes
    • ⚠ Official Swagger operation FacadeServiceV1_UpdateCalculatedAttribute: PUT /api/v1/jobs/{jobId}/attributes/calculated/{id}.

  • officialDeleteCalculatedAttribute

    write

    Deletes a calculated attribute

    Required paramsjobIdid
    Entitiescalculated attributes
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteCalculatedAttribute: DELETE /api/v1/jobs/{jobId}/attributes/calculated/{id}.

  • officialGetCalculatedAttributeByIdCapabilities

    read

    Fetches the calculated attributes capabilities for a job

    Required paramsjobIdid
    Entitiescalculated attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetCalculatedAttributeByIdCapabilities: GET /api/v1/jobs/{jobId}/attributes/calculated/{id}/capabilities.

  • officialGetAttributesCapabilities

    read

    Fetches the attributes capabilities for a single job

    Required paramsjobId
    Entitiesattributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetAttributesCapabilities: GET /api/v1/jobs/{jobId}/attributes/capabilities.

  • officialGetRoadmapAttributes

    read

    Fetches the roadmap attributes for a job

    Required paramsjobId
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetRoadmapAttributes: GET /api/v1/jobs/{jobId}/attributes/roadmap.

  • officialPostRoadmapAttributes

    unknown

    Fetches the roadmap attributes for a job with request in BODY

    Required paramsjobIdparameters
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_PostRoadmapAttributes: POST /api/v1/jobs/{jobId}/attributes/roadmap.

  • officialCreateRoadmapAttribute

    write

    Create a new Roadmap attribute

    Required paramsjobIdconfiguration
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_CreateRoadmapAttribute: PUT /api/v1/jobs/{jobId}/attributes/roadmap.

  • officialGetRoadmapAttributesCapabilities

    read

    Fetches the roadmap attributes capabilities for a job

    Required paramsjobId
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetRoadmapAttributesCapabilities: GET /api/v1/jobs/{jobId}/attributes/roadmap/capabilities.

  • officialUpdateRoadmapAttribute

    write

    Updates a roadmap attribute

    Required paramsjobIdidconfiguration
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_UpdateRoadmapAttribute: PUT /api/v1/jobs/{jobId}/attributes/roadmap/{id}.

  • officialDeleteRoadmapAttribute

    write

    Deletes a roadmap attribute

    Required paramsjobIdid
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteRoadmapAttribute: DELETE /api/v1/jobs/{jobId}/attributes/roadmap/{id}.

  • officialGetRoadmapAttributeByIdCapabilities

    read

    Fetches the roadmap attributes capabilities for a job

    Required paramsjobIdid
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetRoadmapAttributeByIdCapabilities: GET /api/v1/jobs/{jobId}/attributes/roadmap/{id}/capabilities.

  • officialGetRoadmapAttributeIntervals

    read

    Fetches the intervals for a roadmap attribute

    Required paramsjobIdid
    Entitiesroadmap attributes
    • ⚠ Official Swagger operation FacadeServiceV1_GetRoadmapAttributeIntervals: GET /api/v1/jobs/{jobId}/attributes/roadmap/{id}/intervals.

  • officialGetJobCapabilitiesById

    read

    Fetches the capabilities of a job

    Required paramsjobId
    Entitiesjobs
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobCapabilitiesById: GET /api/v1/jobs/{jobId}/capabilities.

  • officialGetConfigurations

    read

    Fetches all job configurations

    Required paramsjobId
    Entitiesconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_GetConfigurations: GET /api/v1/jobs/{jobId}/configurations.

  • officialGetConfigurationsCapabilities

    read

    Fetches job configurations capabilities

    Required paramsjobId
    Entitiesconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_GetConfigurationsCapabilities: GET /api/v1/jobs/{jobId}/configurations/capabilities.

  • officialGetConfigurationByType

    read

    Fetches job configuration by type

    Required paramsjobIdtype
    Entitiesconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_GetConfigurationByType: GET /api/v1/jobs/{jobId}/configurations/{type}.

  • officialCreateOrUpdateConfiguration

    write

    Creates or Updates job configuration

    Required paramsjobIdtypeparameters
    Entitiesconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateConfiguration: PUT /api/v1/jobs/{jobId}/configurations/{type}.

  • officialGetConfigurationCapabilitiesByType

    read

    Fetches job configuration capabilities by type

    Required paramsjobIdtype
    Entitiesconfigurations
    • ⚠ Official Swagger operation FacadeServiceV1_GetConfigurationCapabilitiesByType: GET /api/v1/jobs/{jobId}/configurations/{type}/capabilities.

  • officialGetConnections

    read

    Return the List of connections from the specified well

    Required paramsjobIdparameters
    Entitiesconnections
    • ⚠ Official Swagger operation FacadeServiceV1_GetConnections: POST /api/v1/jobs/{jobId}/data/connections.

  • officialGetConnectionsCapabilities

    read

    Fetch the capabilities of the connections endpoint

    Required paramsjobId
    Entitiesconnections
    • ⚠ Official Swagger operation FacadeServiceV1_GetConnectionsCapabilities: GET /api/v1/jobs/{jobId}/data/connections/capabilities.

  • officialGetDepthData

    read

    Fetches historical depth data with request in BODY

    Required paramsjobIdparameters
    Entitiesdepthbased
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthData: POST /api/v1/jobs/{jobId}/data/depth.

  • officialGetDepthDataCapabilities

    read

    Fetches the capabilities for the GetDepthData endpoint

    Required paramsjobId
    Entitiesdepthbased
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthDataCapabilities: GET /api/v1/jobs/{jobId}/data/depth/capabilities.

  • officialGetDepthExportFormats

    read

    Return different format types available for depth export

    Required paramsjobId
    Entitiesdepthbasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthExportFormats: GET /api/v1/jobs/{jobId}/data/depth/formats.

  • officialGetDepthExportFormatsCapabilities

    read

    Return the capabilities of GetDepthExportFormatsCapabilities endpoint

    Required paramsjobId
    Entitiesdepthbasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthExportFormatsCapabilities: GET /api/v1/jobs/{jobId}/data/depth/formats/capabilities.

  • officialGetDepthExportDelimited

    read

    Return depth data in a delimited file with request in BODY

    Required paramsjobIdparameters
    Entitiesdepthbasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthExportDelimited: POST /api/v1/jobs/{jobId}/data/depth/formats/delimited.

  • officialGetDepthExportFormat

    read

    Return depth data in a file in the selected format with request in BODY

    Required paramsjobIdformatparameters
    Entitiesdepthbasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthExportFormat: POST /api/v1/jobs/{jobId}/data/depth/formats/{format}.

  • officialGetDepthExportFormatCapabilities

    read

    Return the capabilities of GetDepthExportFormatCapabilities endpoint

    Required paramsjobIdformat
    Entitiesdepthbasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetDepthExportFormatCapabilities: GET /api/v1/jobs/{jobId}/data/depth/formats/{format}/capabilities.

  • officialGetFormations

    read

    GET /api/v1/jobs/{jobId}/data/formations

    Required paramsjobIddepthUnitIdangleUnitId
    Entitiesformations
    • ⚠ Official Swagger operation FacadeServiceV1_GetFormations: GET /api/v1/jobs/{jobId}/data/formations.

  • officialCreateOrUpdateFormations

    write

    PUT /api/v1/jobs/{jobId}/data/formations

    Required paramsjobIdbody
    Entitiesformations
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateFormations: PUT /api/v1/jobs/{jobId}/data/formations.

  • officialDeleteFormation

    write

    Deletes the formations for the specified formationId, and for all of the ids in the formationIds…

    Required paramsjobId
    Entitiesformations
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteFormation: DELETE /api/v1/jobs/{jobId}/data/formations.

  • officialGetFormationsCapibilities

    read

    GET /api/v1/jobs/{jobId}/data/formations/capabilities

    Required paramsjobId
    Entitiesformations
    • ⚠ Official Swagger operation FacadeServiceV1_GetFormationsCapibilities: GET /api/v1/jobs/{jobId}/data/formations/capabilities.

  • officialPostDataThirdParty

    write

    Stores third party context data

    Required paramsjobIddata
    Entitiesimportdata
    • ⚠ Official Swagger operation FacadeServiceV1_PostDataThirdParty: POST /api/v1/jobs/{jobId}/data/import/third-party.

  • officialGetMudChecks

    read

    GetMudChecks gets the mud check for the specified Job ID

    Required paramsjobId
    Entitiesmudcheck
    • ⚠ Official Swagger operation FacadeServiceV1_GetMudChecks: GET /api/v1/jobs/{jobId}/data/mud-check.

  • officialCreateOrUpdateMudChecks

    write

    PUT /api/v1/jobs/{jobId}/data/mud-check

    Required paramsjobIdbody
    Entitiesmudcheck
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateMudChecks: PUT /api/v1/jobs/{jobId}/data/mud-check.

  • officialDeleteMudChecks

    write

    DeleteMudChecks deletes the mud check for the specified Job ID

    Required paramsjobIdsourcemudCheckId
    Entitiesmudcheck
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteMudChecks: DELETE /api/v1/jobs/{jobId}/data/mud-check.

  • officialGetMudCheckCapabilities

    read

    GetMudCheckCapabilities fetches the capabilities for the mud check specified by the Job ID.

    Required paramsjobId
    Entitiesmudcheck
    • ⚠ Official Swagger operation FacadeServiceV1_GetMudCheckCapabilities: GET /api/v1/jobs/{jobId}/data/mud-check/capabilities.

  • officialGetNotes

    read

    GetNotes gets all the notes for a job

    Required paramsjobId
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_GetNotes: GET /api/v1/jobs/{jobId}/data/notes.

  • officialCreateNote

    write

    CreateNote creates a note

    Required paramsjobIdnote
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_CreateNote: POST /api/v1/jobs/{jobId}/data/notes.

  • officialUpdateNote

    write

    UpdateNote creates or updates a note

    Required paramsjobIdbody
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_UpdateNote: PUT /api/v1/jobs/{jobId}/data/notes.

  • officialDeleteNote

    write

    DeleteNote deletes the notes for the specified Job ID

    Required paramsjobIdnoteId
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteNote: DELETE /api/v1/jobs/{jobId}/data/notes.

  • officialGetNotesCapabilities

    read

    Fetches the capabilities for the historical notes specified by the Job ID.

    Required paramsjobId
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_GetNotesCapabilities: GET /api/v1/jobs/{jobId}/data/notes/capabilities.

  • officialGetNotesChanges

    read

    GetNotesChanges gets a stream real-time notes change(s) specified by the Job ID

    Required paramsjobId
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_GetNotesChanges: GET /api/v1/jobs/{jobId}/data/notes/changes.

  • officialGetNotesChangesCapabilities

    read

    Fetches the capabilities for the notes changes specified by the Job ID.

    Required paramsjobId
    Entitiesnotes
    • ⚠ Official Swagger operation FacadeServiceV1_GetNotesChangesCapabilities: GET /api/v1/jobs/{jobId}/data/notes/changes/capabilities.

  • officialGetRunsByJob

    read

    Return all runs for a given job

    Required paramsjobId
    Entitiesruns
    • ⚠ Official Swagger operation FacadeServiceV1_GetRunsByJob: GET /api/v1/jobs/{jobId}/data/runs.

  • officialGetBhas

    read

    GetBhas gets all the Bha assembly for the specified Job ID

    Required paramsjobId
    Entitiesbhas
    • ⚠ Official Swagger operation FacadeServiceV1_GetBhas: GET /api/v1/jobs/{jobId}/data/runs/bhas.

  • officialCreateOrUpdateBhas

    write

    CreateBhas creates the Bha assembly for the specified Job ID

    Required paramsjobIdbody
    Entitiesbhas
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateBhas: PUT /api/v1/jobs/{jobId}/data/runs/bhas.

  • officialDeleteBhas

    write

    DeleteBhas deletes Bha assembly for the specified Job ID

    Required paramsjobIdsourcebhaId
    Entitiesbhas
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteBhas: DELETE /api/v1/jobs/{jobId}/data/runs/bhas.

  • officialGetBhasCapabilities

    read

    GetBhasCapabilities fetches the capabilities for the Bha specified by the Job ID.

    Required paramsjobId
    Entitiesbhas
    • ⚠ Official Swagger operation FacadeServiceV1_GetBhasCapabilities: GET /api/v1/jobs/{jobId}/data/runs/bhas/capabilities.

  • officialGetRunsCapabilities

    read

    Fetches the capabilities for the runs by the Job ID.

    Required paramsjobId
    Entitiesruns
    • ⚠ Official Swagger operation FacadeServiceV1_GetRunsCapabilities: GET /api/v1/jobs/{jobId}/data/runs/capabilities.

  • officialGetCasings

    read

    GetCasings gets all the Casing Strings for the specified Job ID

    Required paramsjobId
    Entitiescasings
    • ⚠ Official Swagger operation FacadeServiceV1_GetCasings: GET /api/v1/jobs/{jobId}/data/runs/casings.

  • officialCreateOrUpdateCasings

    write

    CreateCasings the Casing Strings for the specified Job ID

    Required paramsjobIdbody
    Entitiescasings
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateCasings: PUT /api/v1/jobs/{jobId}/data/runs/casings.

  • officialDeleteCasings

    write

    DeletCasings deletes the Casing Strings for the specified Job ID

    Required paramsjobIdsourcecasingId
    Entitiescasings
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteCasings: DELETE /api/v1/jobs/{jobId}/data/runs/casings.

  • officialGetCasingsCapabilities

    read

    GetCasingsCapabilities fetches the capabilities for the Casing Strings specified by the Job ID.

    Required paramsjobId
    Entitiescasings
    • ⚠ Official Swagger operation FacadeServiceV1_GetCasingsCapabilities: GET /api/v1/jobs/{jobId}/data/runs/casings/capabilities.

  • officialGetEquivalentMudWeight

    read

    GetEquivalentMudWeights retrieves swab/surge emw points.

    Required paramsjobIdrunIdswabSurgeType
    Entitiesswabsurge
    • ⚠ Official Swagger operation FacadeServiceV1_GetEquivalentMudWeight: GET /api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}.

  • officialCreateSwabSurgeData

    write

    CreateSwabSurgeData saves swab/surge data.

    Required paramsjobIdrunIdswabSurgeTypeswabSurgeData
    Entitiesswabsurge
    • ⚠ Official Swagger operation FacadeServiceV1_CreateSwabSurgeData: PUT /api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}.

  • officialGetEquivalentMudWeightCapabilities

    read

    GetEquivalentMudWeightCapabilities retrieves capabilities for swab/surge emw.

    Required paramsjobIdrunIdswabSurgeType
    Entitiesswabsurge
    • ⚠ Official Swagger operation FacadeServiceV1_GetEquivalentMudWeightCapabilities: GET /api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}/capabilities.

  • officialGetTripSpeedModel

    read

    GetTripSpeedModel retrieves generated swab/surge tripping model for equivalent mud weights

    Required paramsjobIdrunIdswabSurgeTypeparameters
    Entitiesswabsurge
    • ⚠ Official Swagger operation FacadeServiceV1_GetTripSpeedModel: POST /api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}/trip-speed.

  • officialGetTripSpeedModelCapabilities

    read

    GetTripSpeedModelCapabilities retrieves capabilities for swab/surge tripping speed model.

    Required paramsjobIdrunIdswabSurgeType
    Entitiesswabsurge
    • ⚠ Official Swagger operation FacadeServiceV1_GetTripSpeedModelCapabilities: GET /api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}/trip-speed/capabilities.

  • officialGetSectionsByJob

    read

    Return all sections for a given job

    Required paramsjobId
    Entitiessections
    • ⚠ Official Swagger operation FacadeServiceV1_GetSectionsByJob: GET /api/v1/jobs/{jobId}/data/sections.

  • officialGetSectionsCapabilities

    read

    Fetches the capabilities for the sections by the Job ID.

    Required paramsjobId
    Entitiessections
    • ⚠ Official Swagger operation FacadeServiceV1_GetSectionsCapabilities: GET /api/v1/jobs/{jobId}/data/sections/capabilities.

  • officialGetSurveys

    read

    GetSurveys gets all the surveys filtered by the optional parameters approved, unapproved,…

    Required paramsjobId
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_GetSurveys: GET /api/v1/jobs/{jobId}/data/surveys.

  • officialCreateSurveys

    write

    CreateSurveys creates Surveys for the specified Job ID

    Required paramsjobIdparameters
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_CreateSurveys: PUT /api/v1/jobs/{jobId}/data/surveys.

  • officialGetSurveysCapabilities

    read

    Fetches the capabilities for the historical surveys specified by the Job ID.

    Required paramsjobId
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_GetSurveysCapabilities: GET /api/v1/jobs/{jobId}/data/surveys/capabilities.

  • officialGetCurrentSurvey

    read

    GetCurrentSurvey gets the real-time survey specified by the Job ID, filtered by the optional…

    Required paramsjobId
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentSurvey: GET /api/v1/jobs/{jobId}/data/surveys/current.

  • officialGetCurrentSurveyCapabilities

    read

    Fetches the capabilities for the real-time survey specified by the Job ID.

    Required paramsjobId
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentSurveyCapabilities: GET /api/v1/jobs/{jobId}/data/surveys/current/capabilities.

  • officialGetHistoricalTimeData

    read

    Return historical data with request in BODY

    Required paramsjobIdparameters
    Entitiestimebased
    • ⚠ Official Swagger operation FacadeServiceV1_GetHistoricalTimeData: POST /api/v1/jobs/{jobId}/data/time.

  • officialGetTimeOffsets

    read

    Returns a list of DateTimeOffsets for the specified job

    Required paramsjobId
    Entitiestimeoffsets
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeOffsets: GET /api/v1/jobs/{jobId}/data/time-offsets.

  • officialGetTimeOffsetsCapabilities

    read

    Fetches the capabilities for the GetTimeOffsets endpoint

    Required paramsjobId
    Entitiestimeoffsets
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeOffsetsCapabilities: GET /api/v1/jobs/{jobId}/data/time-offsets/capabilities.

  • officialGetHistoricalTimeDataCapabilities

    read

    Fetches the capabilities for the GetHistoricalTimeData endpoint

    Required paramsjobId
    Entitiestimebased
    • ⚠ Official Swagger operation FacadeServiceV1_GetHistoricalTimeDataCapabilities: GET /api/v1/jobs/{jobId}/data/time/capabilities.

  • officialGetCurrentTimeDataUri

    read

    Return last known values with request in URI

    Required paramsjobIdinterval
    Entitiestimebased
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentTimeDataUri: GET /api/v1/jobs/{jobId}/data/time/current.

  • officialGetCurrentTimeData

    read

    Return last known values with request in BODY

    Required paramsjobIdparameters
    Entitiestimebased
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentTimeData: POST /api/v1/jobs/{jobId}/data/time/current.

  • officialGetCurrentTimeDataCapabilities

    read

    Fetches the capabilities for the GetCurrentTimeData endpoint

    Required paramsjobId
    Entitiestimebased
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentTimeDataCapabilities: GET /api/v1/jobs/{jobId}/data/time/current/capabilities.

  • officialGetEvents

    read

    Retrieves a list of events over a time range

    Required paramsjobIdparameters
    Entitiesevents
    • ⚠ Official Swagger operation FacadeServiceV1_GetEvents: POST /api/v1/jobs/{jobId}/data/time/events.

  • officialGetEventsCapabilities

    read

    Fetches the capabilities of the GetEvents endpoint

    Required paramsjobId
    Entitiesevents
    • ⚠ Official Swagger operation FacadeServiceV1_GetEventsCapabilities: GET /api/v1/jobs/{jobId}/data/time/events/capabilities.

  • officialGetTimeExportFormats

    read

    Return different format types available for time export

    Required paramsjobId
    Entitiestimebasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeExportFormats: GET /api/v1/jobs/{jobId}/data/time/formats.

  • officialGetTimeExportFormatsCapabilities

    read

    Return the capabilities of GetTimeExportFormatsCapabilities endpoint

    Required paramsjobId
    Entitiestimebasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeExportFormatsCapabilities: GET /api/v1/jobs/{jobId}/data/time/formats/capabilities.

  • officialGetTimeExportDelimited

    read

    Return time data in a delimited file with request in BODY

    Required paramsjobIdparameters
    Entitiestimebasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeExportDelimited: POST /api/v1/jobs/{jobId}/data/time/formats/delimited.

  • officialGetTimeExportDelimitedNoNullRows

    read

    Return time data in a delimited file with request in BODY and remove the rows that have empty…

    Required paramsjobIdparameters
    Entitiestimebasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeExportDelimitedNoNullRows: POST /api/v1/jobs/{jobId}/data/time/formats/delimitedNoNullRows.

  • officialGetTimeExportFormat

    read

    Return time data in a file in the selected format with request in BODY

    Required paramsjobIdformatparameters
    Entitiestimebasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeExportFormat: POST /api/v1/jobs/{jobId}/data/time/formats/{format}.

  • officialGetTimeExportFormatCapabilities

    read

    Return the capabilities of GetTimeExportFormatCapabilities endpoint

    Required paramsjobIdformat
    Entitiestimebasedexport
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeExportFormatCapabilities: GET /api/v1/jobs/{jobId}/data/time/formats/{format}/capabilities.

  • officialGetTimeSummary

    read

    GetTimeSummary gets the time summary for the specified job and attribute IDs.

    Required paramsjobIdattributeIdinterval
    Entitiestimesummary
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeSummary: GET /api/v1/jobs/{jobId}/data/time/{attributeId}/time-summary.

  • officialGetTimeSummaryCapabilities

    read

    GetTimeSummaryCapabilities gets the time summary for the specified job and attribute IDs.

    Required paramsjobIdattributeId
    Entitiestimesummary
    • ⚠ Official Swagger operation FacadeServiceV1_GetTimeSummaryCapabilities: GET /api/v1/jobs/{jobId}/data/time/{attributeId}/time-summary/capabilities.

  • officialGetTorqueDragRunDataByJob

    read

    Return run data with request in BODY

    Required paramsjobIdparameters
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_GetTorqueDragRunDataByJob: POST /api/v1/jobs/{jobId}/data/torque-drag.

  • officialGetTorqueDragRunDataCapabilities

    read

    Fetches the capabilities for the torque drag run data by the Job ID.

    Required paramsjobId
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_GetTorqueDragRunDataCapabilities: GET /api/v1/jobs/{jobId}/data/torque-drag/capabilities.

  • officialGetPressureModels

    read

    GET /api/v1/jobs/{jobId}/models/pressure

    Required paramsjobIddepthUnitIdpressureUnitIddensityUnitId
    Entitiespressuremodels
    • ⚠ Official Swagger operation FacadeServiceV1_GetPressureModels: GET /api/v1/jobs/{jobId}/models/pressure.

  • officialCreateOrUpdatePressureModels

    write

    PUT /api/v1/jobs/{jobId}/models/pressure

    Required paramsjobIdbody
    Entitiespressuremodels
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdatePressureModels: PUT /api/v1/jobs/{jobId}/models/pressure.

  • officialDeletePressureModel

    write

    DELETE /api/v1/jobs/{jobId}/models/pressure

    Required paramsjobIdsourcepressureModelId
    Entitiespressuremodels
    • ⚠ Official Swagger operation FacadeServiceV1_DeletePressureModel: DELETE /api/v1/jobs/{jobId}/models/pressure.

  • officialGetPressureModelsCapabilities

    read

    GET /api/v1/jobs/{jobId}/models/pressure/capabilities

    Required paramsjobId
    Entitiespressuremodels
    • ⚠ Official Swagger operation FacadeServiceV1_GetPressureModelsCapabilities: GET /api/v1/jobs/{jobId}/models/pressure/capabilities.

  • officialGetSurveyModels

    read

    GetSurveyModels gets all the survey models filtered by the optional parameters fromDepth, endDepth

    Required paramsjobId
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_GetSurveyModels: GET /api/v1/jobs/{jobId}/models/surveys.

  • officialGetSurveyModelsCapabilities

    read

    Fetches the capabilities for the historical surveys specified by the Job ID.

    Required paramsjobId
    Entitiessurveys
    • ⚠ Official Swagger operation FacadeServiceV1_GetSurveyModelsCapabilities: GET /api/v1/jobs/{jobId}/models/surveys/capabilities.

  • officialGetAvailableTorqueDragModelsByJob

    read

    Return available torque and drag model identifiers for the specified job.

    Required paramsjobId
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_GetAvailableTorqueDragModelsByJob: GET /api/v1/jobs/{jobId}/models/torque-drag.

  • officialGetTorqueDragModelByJob

    read

    Return torque and drag model with request in BODY

    Required paramsjobIdparameters
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_GetTorqueDragModelByJob: POST /api/v1/jobs/{jobId}/models/torque-drag.

  • officialCreateOrUpdateTorqueDragModelByJob

    write

    CreateTorqueDragModels creates the Torque and Drag model for a specified run

    Required paramsjobIdparameters
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateTorqueDragModelByJob: PUT /api/v1/jobs/{jobId}/models/torque-drag.

  • officialGetTorqueDragModelsCapabilities

    read

    Fetches the capabilities for the torque drag models by the Job ID.

    Required paramsjobId
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_GetTorqueDragModelsCapabilities: GET /api/v1/jobs/{jobId}/models/torque-drag/capabilities.

  • officialGetTorqueDragModelById

    read

    Return torque and drag model with run id in PATH

    Required paramsjobIdmodelId
    Entitiestorquedrag
    • ⚠ Official Swagger operation FacadeServiceV1_GetTorqueDragModelById: GET /api/v1/jobs/{jobId}/models/torque-drag/{modelId}.

  • officialGetJobReportClassifications

    read

    Fetches the list of report classifications with available reports for the given job

    Required paramsjobId
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobReportClassifications: GET /api/v1/jobs/{jobId}/reports.

  • officialGetReportsCapabilities

    read

    Fetches the capabilities of reports endpoint

    Required paramsjobId
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReportsCapabilities: GET /api/v1/jobs/{jobId}/reports/capabilities.

  • officialGetAvailableSummaryReports

    read

    Return the list of available well summary reports for the specified well

    Required paramsjobId
    Entitiessummaryreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetAvailableSummaryReports: GET /api/v1/jobs/{jobId}/reports/summary.

  • officialGetAvailableSummaryReportsCapabilities

    read

    Return the capabilities of well summary reports

    Required paramsjobId
    Entitiessummaryreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetAvailableSummaryReportsCapabilities: GET /api/v1/jobs/{jobId}/reports/summary/capabilities.

  • officialGetSummaryReport

    read

    Fetches the specified summary report

    Required paramsjobIdsummaryReportIdfileFormatId
    Entitiessummaryreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetSummaryReport: GET /api/v1/jobs/{jobId}/reports/summary/{summaryReportId}/{fileFormatId}.

  • officialGetSummaryReportParameterized

    read

    Return the specified summary reports via file download

    Required paramsjobIdsummaryReportIdfileFormatIdparameters
    Entitiessummaryreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetSummaryReportParameterized: POST /api/v1/jobs/{jobId}/reports/summary/{summaryReportId}/{fileFormatId}.

  • officialGetSummaryReportFilesCapabilities

    read

    Fetches the capabilities of summary reports format endpoint

    Required paramsjobIdsummaryReportIdfileFormatId
    Entitiessummaryreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetSummaryReportFilesCapabilities: GET /api/v1/jobs/{jobId}/reports/summary/{summaryReportId}/{fileFormatId}/capabilities.

  • officialGetReportGroups

    read

    Fetches the list of report groups with available reports for the given job

    Required paramsjobIdclassification
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReportGroups: GET /api/v1/jobs/{jobId}/reports/{classification}.

  • officialGetJobReportsClassificationCapabilities

    read

    Fetches the capabilities of reports classification endpoint

    Required paramsjobIdclassification
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetJobReportsClassificationCapabilities: GET /api/v1/jobs/{jobId}/reports/{classification}/capabilities.

  • officialGetAvailableReports

    read

    Fetches a list of all the available reports within the given report classification and group for…

    Required paramsjobIdclassificationreportGroupId
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetAvailableReports: GET /api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}.

  • officialGetReportsGroupCapabilities

    read

    Fetches the capabilities of reports group endpoint

    Required paramsjobIdclassificationreportGroupId
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReportsGroupCapabilities: GET /api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/capabilities.

  • officialGetReport

    read

    Fetches the specified reports via file download

    Required paramsjobIdclassificationreportGroupIdfileFormatId
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReport: GET /api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/{fileFormatId}.

  • officialGetReportParameterized

    read

    Return the specified reports via file download

    Required paramsjobIdclassificationreportGroupIdfileFormatIdparameters
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReportParameterized: POST /api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/{fileFormatId}.

  • officialGetReportFilesCapabilities

    read

    Fetches the capabilities of reports format endpoint

    Required paramsjobIdclassificationreportGroupIdfileFormatId
    Entitiesjob reports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReportFilesCapabilities: GET /api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/{fileFormatId}/capabilities.

  • officialGetSegmentsByJob

    read

    Return all segments for a given job

    Required paramsjobId
    Entitiessegments
    • ⚠ Official Swagger operation FacadeServiceV1_GetSegmentsByJob: GET /api/v1/jobs/{jobId}/segments.

  • officialCreateOrUpdateSegments

    write

    CreateOrUpdateSegments allows a user to create or update segments for a specific job

    Required paramsjobIdbody
    Entitiessegments
    • ⚠ Official Swagger operation FacadeServiceV1_CreateOrUpdateSegments: PUT /api/v1/jobs/{jobId}/segments.

  • officialDeleteSegments

    write

    DeleteSegments deletes one or more segments, if permissible

    Required paramsjobId
    Entitiessegments
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteSegments: DELETE /api/v1/jobs/{jobId}/segments.

  • officialGetSegmentsCapabilities

    read

    GetSegmentsCapabilities fetches the capabilities for the segments specified by the Job ID.

    Required paramsjobId
    Entitiessegments
    • ⚠ Official Swagger operation FacadeServiceV1_GetSegmentsCapabilities: GET /api/v1/jobs/{jobId}/segments/capabilities.

  • officialGetSegmentById

    read

    GetSegmentByID gets the specific segment by id provided

    Required paramsjobIdid
    Entitiessegments
    • ⚠ Official Swagger operation FacadeServiceV1_GetSegmentById: GET /api/v1/jobs/{jobId}/segments/{id}.

  • officialGetSegmentCapabilities

    read

    GetSegmentCapabilities fetches the capabilities for the specific segment specified by the…

    Required paramsjobIdid
    Entitiessegments
    • ⚠ Official Swagger operation FacadeServiceV1_GetSegmentCapabilities: GET /api/v1/jobs/{jobId}/segments/{id}/capabilities.

  • officialGetUploadedFilesProperties

    read

    Fetches the list of uploaded files properties for the specified Job ID.

    Required paramsjobId
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFilesProperties: GET /api/v1/jobs/{jobId}/uploadedFiles.

  • officialCreateUploadedFile

    write

    Upload a file for the specified Job ID. Expected form data: Description - Description of file…

    Required paramsjobIdbody
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_CreateUploadedFile: PUT /api/v1/jobs/{jobId}/uploadedFiles.

  • officialGetUploadedFilesCapabilities

    read

    Fetches the capabilities for the uploaded files specified by the Job Id.

    Required paramsjobId
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFilesCapabilities: GET /api/v1/jobs/{jobId}/uploadedFiles/capabilities.

  • officialGetUploadedFile

    read

    Download file by Job ID and ID.

    Required paramsjobIdid
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFile: GET /api/v1/jobs/{jobId}/uploadedFiles/{id}.

  • officialDeleteUploadedFile

    write

    Delete the specified file for specified Job ID and File ID.

    Required paramsjobIdid
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteUploadedFile: DELETE /api/v1/jobs/{jobId}/uploadedFiles/{id}.

  • officialGetUploadedFileCapabilities

    read

    Fetches the capabilities for the specific uploaded file specified by the File Id and the Job Id.

    Required paramsjobIdid
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFileCapabilities: GET /api/v1/jobs/{jobId}/uploadedFiles/{id}/capabilities.

  • officialGetUploadedFileProperties

    read

    Fetches the uploaded file properties for the specified Job ID and file ID.

    Required paramsjobIdid
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFileProperties: GET /api/v1/jobs/{jobId}/uploadedFiles/{id}/properties.

  • officialGetUploadedFilePropertiesCapabilities

    read

    Fetches the uploaded file property's capabilities for the specified Job ID and file ID.

    Required paramsjobIdid
    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFilePropertiesCapabilities: GET /api/v1/jobs/{jobId}/uploadedFiles/{id}/properties/capabilities.

  • officialGetMeta

    read

    Return a list of key/value pairs from meta data.

    Entitiesmeta
    • ⚠ Official Swagger operation FacadeServiceV1_GetMeta: GET /api/v1/meta.

  • officialGetMetaCapabilities

    read

    Fetches the capabilities for the Meta endpoint

    Entitiesmeta
    • ⚠ Official Swagger operation FacadeServiceV1_GetMetaCapabilities: GET /api/v1/meta/capabilities.

  • officialGetMetaByKey

    read

    Reads meta data.

    Required paramskey
    Entitiesmeta
    • ⚠ Official Swagger operation FacadeServiceV1_GetMetaByKey: GET /api/v1/meta/{key}.

  • officialPutMetaByKey

    write

    Stores meta data. Meta data is not interpreted and will be returned when calling read with the…

    Required paramskeydata
    Entitiesmeta
    • ⚠ Official Swagger operation FacadeServiceV1_PutMetaByKey: PUT /api/v1/meta/{key}.

  • officialDeleteMetaByKey

    write

    Deletes meta data. Deleting data for a key with no associated data silently does nothing.

    Required paramskey
    Entitiesmeta
    • ⚠ Official Swagger operation FacadeServiceV1_DeleteMetaByKey: DELETE /api/v1/meta/{key}.

  • officialGetMetaByKeyCapabilities

    read

    Fetches the capabilities for the Meta endpoint

    Required paramskey
    Entitiesmeta
    • ⚠ Official Swagger operation FacadeServiceV1_GetMetaByKeyCapabilities: GET /api/v1/meta/{key}/capabilities.

  • officialGetReportClassifications

    read

    Return available report classifications

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetReportClassifications: GET /api/v1/reports.

  • officialGetMultiJobSummaryClassificationsCapabilities

    read

    Fetches the capabilities of reports endpoint

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryClassificationsCapabilities: GET /api/v1/reports/capabilities.

  • officialGetNextReport

    read

    Return the next report

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextReport: GET /api/v1/reports/next.

  • officialGetNextDeletedReport

    read

    Return the next deleted report

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextDeletedReport: GET /api/v1/reports/next-deleted.

  • officialGetNextDeletedReportCapabilities

    read

    Fetches the capabilities of the next deleted report endpoint

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextDeletedReportCapabilities: GET /api/v1/reports/next-deleted/capabilities.

  • officialGetNextReportCapabilities

    read

    Fetches the capabilities of the next report endpoint

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextReportCapabilities: GET /api/v1/reports/next/capabilities.

  • officialGetMultiJobSummaryAvailableReports

    read

    Return available reports for the given classification for Multi-Job Summary Reports

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryAvailableReports: GET /api/v1/reports/summary.

  • officialGetMultiJobSummaryAvailableReportsCapabilities

    read

    Fetches the capabilities of reports classification endpoint

    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryAvailableReportsCapabilities: GET /api/v1/reports/summary/capabilities.

  • officialGetMultiJobSummaryReportInformation

    read

    Return available formats for the summary report

    Required paramssummaryReportId
    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryReportInformation: GET /api/v1/reports/summary/{summaryReportId}.

  • officialGetMultiJobSummaryReportInformationCapabilities

    read

    Fetches the capabilities of summary report id endpoint

    Required paramssummaryReportId
    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryReportInformationCapabilities: GET /api/v1/reports/summary/{summaryReportId}/capabilities.

  • officialGetMultiJobSummaryReport

    read

    Return a pdf or zip file with the summary report for all wells in the time range

    Required paramssummaryReportIdfileFormatId
    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryReport: GET /api/v1/reports/summary/{summaryReportId}/{fileFormatId}.

  • officialGetMultiJobSummaryReportParametrized

    read

    Return a pdf or zip file with the summary report for all wells in the time range

    Required paramssummaryReportIdfileFormatIdparameters
    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryReportParametrized: POST /api/v1/reports/summary/{summaryReportId}/{fileFormatId}.

  • officialGetMultiJobSummaryReportCapabilities

    read

    Return capabilities for the multi job summary report endpoint

    Required paramssummaryReportIdfileFormatId
    Entitiesreports
    • ⚠ Official Swagger operation FacadeServiceV1_GetMultiJobSummaryReportCapabilities: GET /api/v1/reports/summary/{summaryReportId}/{fileFormatId}/capabilities.

  • officialGetUnitDefinitions

    read

    GetUnitDefinitions retrieves unit of measure definitions

    Entitiesunits
    • ⚠ Official Swagger operation FacadeServiceV1_GetUnitDefinitions: GET /api/v1/units/definitions.

  • officialGetUnitDefinitionsCapabilities

    read

    GetUnitDefinitionsCapabilities retrieves capabilities for unit definitions

    Entitiesunits
    • ⚠ Official Swagger operation FacadeServiceV1_GetUnitDefinitionsCapabilities: GET /api/v1/units/definitions/capabilities.

  • officialGetNextUploadedFilesKey

    read

    Fetches the starting next uploaded files key for the specified timestamp.

    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextUploadedFilesKey: GET /api/v1/uploadedFiles.

  • officialGetUploadedFilesNextKeyCapabilities

    read

    Fetches the capabilities of the uploaded files Next Key endpoint.

    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetUploadedFilesNextKeyCapabilities: GET /api/v1/uploadedFiles/capabilities.

  • officialGetNextUploadedFile

    read

    Fetches the next uploaded file after the specified cursor.

    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextUploadedFile: GET /api/v1/uploadedFiles/next.

  • officialGetNextUploadedFileCapabilities

    read

    Fetches the capabilities of the next uploaded file endpoint.

    Entitiesuploadedfiles
    • ⚠ Official Swagger operation FacadeServiceV1_GetNextUploadedFileCapabilities: GET /api/v1/uploadedFiles/next/capabilities.

  • officialGetCurrentUser

    read

    Fetches the current user

    Entitiesusers
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentUser: GET /api/v1/users/current.

  • officialGetCurrentUserCapabilities

    read

    Fetches the capabilities of the current user endpoint

    Entitiesusers
    • ⚠ Official Swagger operation FacadeServiceV1_GetCurrentUserCapabilities: GET /api/v1/users/current/capabilities.

  • officialGetVersions

    read

    GetVersions returns the minimum supported iOS and Android versions of the MDM app. No…

    Entitiesversions
    • ⚠ Official Swagger operation FacadeServiceV1_GetVersions: GET /api/v1/versions.