/
Qbyte CS Land APIs


Qbyte CS Land APIs



Back to Qbyte 360 Connect API Reference Guide

Overview/Introduction

External REST APIs

The following REST APIs are exposed for external use:

Config

Method

Parameters

Return Values

Description

Method

Parameters

Return Values

Description

GET - /v1/Config/print

none

ContentResult JSON object

An HTML website that displays information about the deployed API.

GET - /v1/Config/{key}/print

Key – GET Path – string

STRING

Get a specific key within all available objects and display it as plain text

GET - /v1/Config

none

ApiConfig JSON object

Get all available configuration values as JSON

GET - /v1/Config/{key}

Key – GET Path – string

KeyValue pair JSON object

Get a specific configuration value as JSON



Licenses

Method

Parameters

Return Values

Description

Method

Parameters

Return Values

Description

GET - /v1/wells/{fileNumber}/Licence

FileNumber – GET Path – string

CollectionResult with results field an array of WellLicence JSON objects.

Get a set of Licences from the Licences collection.

PUT - /v1/wells/{fileNumber}/Licence

License – PUT Body – WellLicence JSON object

UploadEntity JSON object of a WellLicence JSON object

Update a Well Licence

POST - /v1/wells/{fileNumber}/Licence

License – POST Body – WellLicence JSON object

UploadEntity JSON object of a WellLicence JSON object

Update a Well Licence



GET - /v1/wells/Licences

Skip – GET path – integer

· Top – GET path – integer

· OrderBy – GET path – string

· Keywords – GET path – string

CollectionResult with results field an array of WellLicence JSON objects.

Get all Well Licences from CS Land

PUT - /v1/wells/Licences/batch

Licences – PUT body – Array of WellLicence JSON objects

UploadEntity JSON object of an array of WellLicence JSON objects.



Mass update of Well Licences in CS Land

/v1/wells/Licences/batch

Licences – POST body – Array of WellLicence JSON objects

UploadEntity JSON object of an array of WellLicence JSON objects.

Mass insert of Well Licences in CS Land

POST - /v1/wells/Licences/batch

Licences – POST body – Array of WellLicence JSON objects

UploadEntity JSON object of an array of WellLicence JSON objects.

Mass insert of Well Licences in CS Land



Remarks

Method

Parameters

Return Values

Description

Method

Parameters

Return Values

Description

GET - /v1/wells/{fileNumber}/Remarks/{occurrence}

FileNumber – GET path – string

· Occurrence – GET path – string

CollectionResult with results field an array of WellRemark JSON objects.

Get a set of Remarks from the Remarks collection.

PUT - /v1/wells/{fileNumber}/Remarks/{occurrence}

Remark – PUT Body – WellRemark JSON object.

UploadEntity JSON object of a WellRemark JSON object

Update a Well Remark.



39.15 GET - /v1/wells/{fileNumber}/Remarks



FileNumber – GET path – string



CollectionResult with results field an array of WellRemark JSON objects.

Get a set of Remarks from the Remarks collection

POST - /v1/wells/{fileNumber}/Remarks



Insert a Well Remark.



UploadEntity JSON object of a WellRemark JSON object

Insert a Well Remark.



PUT - /v1/wells/Remarks/batch

Remarks – PUT body – Array of WellRemark JSON objects

UploadEntity JSON object of an array of WellRemark JSON objects.

Mass update of Well Remarks in CS Land

POST - /v1/wells/Remarks/batch

Remarks – POST body – Array of WellRemark JSON objects

UploadEntity JSON object of an array of WellRemark JSON objects.

Mass insert of Well Remarks in CS Land.



Wells

Method

Parameters

Return Values

Description

Method

Parameters

Return Values

Description

GET - /v1/wells



Skip – GET path – integer

· Top – GET path – integer

· Orderby – GET path – string

· Keywords – GET path – string

CollectionResult with results field an array of WellBase JSON objects.



Get all Wells from CS Land

POST - /v1/wells

Authorization – POST header – string

· Well – POST body – JSON object

UploadEntity JSON object of a WellBase JSON object

Create a new Well in CS Land.

GET - /v1/wells/{fileNumber}

fileNumber – GET path – string



WellBase JSON object.



Get a specific Well from CS Land.

PUT - /v1/wells/{fileNumber}



Authorization – PUT header – string

· FileNumber – PUT path – string · Well – PUT body – WellBase JSON object

UploadEntity JSON object of a WellBase JSON object.

Update a Well in CS Land.



PUT - /v1/wells/batch



Authorization – PUT header – string

Well – PUT body – Array of WellBase JSON objects

UploadEntity JSON object of an array of WellBase JSON objects.

Mass update of Wells in CS Land.

POST - /v1/wells/batch



Authorization – POST header – string

· Well – POST body – Array of JSON objects

UploadEntity JSON object of an array of WellBase JSON objects.

Mass insert of Wells in CS Land



JSON Objects in use by CS Land APIs

ContentResult

{

"content": "string",

"contentType": "string",

"statusCode": 0

}



ApiConfig

{

"name": "string",

"apiVersion": "string",

"buildNumber": "string",

"cSLandVersion": "string",

"applicationDatabase": "string",

"applicationDatabaseSchema": "string",

"maxUploadEntityRows": "string",

"serverOSVersion": "string",

"dotNETVersion": "string"

}



KeyValue

{

"key": "string",

"value": {}

}

ContentResult

{

"content": "string",

"contentType": "string",

"statusCode": 0

}



ApiConfig

{

"name": "string",

"apiVersion": "string",

"buildNumber": "string",

"cSLandVersion": "string",

"applicationDatabase": "string",

"applicationDatabaseSchema": "string",

"maxUploadEntityRows": "string",

"serverOSVersion": "string",

"dotNETVersion": "string"

}



KeyValue

{

"key": "string",

"value": {}

}



CollectionResult

{

"count": 0,

"total": 0,

"top": 0,

"skip": 0,

"results": [{…}]

}



UploadEntity

{

"uploadEntity": {…},

"uploadEntityStatus":

{

"uploadStatusName": "string",

"uploadStatus": 0,

"uploadStatusMessageContext": "string",

"uploadStatusMessage": "string"

}

}



CollectionResult

{

"count": 0,

"total": 0,

"top": 0,

"skip": 0,

"results": [{…}]

}



WellBase

{

"fileNumber": "string",

"wellUWI": "string",

"fileStatus": "string",

"statusDate": "string",

"wellName": "string",

"wellStatus": "string",

"wellType": "string",

"wellStatusDate": "string",

"penalty": "string",

"governmentStatus": "string",

"directionDrilled": "string",

"lessorType": "string",

"WellLicencee": "string",

"confidentFlag": "string",

"governAgmtOper": "string",

"governingContract": "string",

"adminCompany": "string",

"area": "string",

"district": "string",

"division": "string",

"spudDate": "string",

"rigReleaseDate": "string",

"completionDate": "string",

"onProductionDate": "string",

"payoutDate": "string",

"abandonedDate": "string",

"shutinDate": "string",

"shutinReason": "string",

"injectionDate": "string",

"lastProdDate": "string"

}



WellLicence

{

"fileNumber": "string",

"contractOperator": "string",

"reserve": "string",

"facility": "string",

"field": "string",

"pool": "string",

"licenceNumber": "string",

"licenceDate": "string",

"expiryDate": "string",

"surfaceLocation": "string",

"metes": "string",

"metesDirection": "string",

"bounds": "string",

"boundsDirection": "string",

"lAHEEClassification": "string",

"drillingSpacingUnit": "stri

"dSUUnitofMeasure": "string",

"accountingProject": "string",

"projectedDepth": "string",

"totalDepth": "string",

"trueVerticalDepth": "string",

"plugBackDepth": "string",

"groundElevation": "string",

"kellyBushingElev": "string",

"unitofMeasure": "string",

"totalDepthZone": "string",

"producingZone": "string",

"targetZone": "string",

"govtUnitCode": "string"

}



WellRemark

{

"fileNumber": "string",

"occurrence": "string",

"remarkType": "string",

"remarkDate": "string",

"remark": "string"

}



 

Related content


Copyright© 2024 IFS AB. Copying prohibited. All rights reserved.