Current Standards

CURRENT VERSION

Preferred version for new and upgraded production implementations.

WITSML Data Schema Specifications, Version 1.4.1  

WITSML API Specifications, version 1.4.1 

supporting documentation

In addition to the API and schema specifications, a series of usage guides and other supporting documentation and tools are under development to help assist users and implementers. This library will grow over time.

USAGE GUIDES 

• stimJob Object Usage Guide
• Lithology Element Usage Guide (Updated January 2012)

TOOLS

• XSLT transform between v1.3.1.1 and v1.4.1

data schema specifications

Key changes since the previous production release of WITSML, which was version 1.3.1.1.

• ADDED stimJob data object - used for post job summary reporting for stimulation (fracturing) jobs
• ADDED drillReport data object - used to capture a daily drilling report focused on reporting from the operator to partners or to a government agency.
• ADDED toolErrorModel data object - used to define a set of surveying tool error terms which may be used in a toolErrorModel.    
• ADDED attachment data object - used to provide a central location for finding a digital attachment that is associated with another WITSML well-related data object.
• ADDED objectGroup data object - replaces wellLog by capturing explicit knowledge that a group of objects are directly related. This is intended to support concepts such as wireline logging, logging while drilling, well tests, wireline formation tests, etc. While primary use targets logs, it can be used to collect any data object into a group.
• REMOVED dtsInstalledSystem - now supported by PRODML.
• REMOVED dtsMeasurement - now supported by PRODML.
• REMOVED trajectoryStation - no longer needed for adding individual stations to the trajectory.
• REMOVED realtime - with changes to the API query capability, this is now redundant to log.
• REMOVED wellLog - redundant to new objectGroup
• CHANGED log to allow log queries to be more efficient using API.
• CHANGED mudlog to clarify lithology.

Refer to the Data Schema Overview (linked above) for more detailed information.

API specification

• Removed the wellLog data object. Functionality has been combined with the log data object, for a cleaner, simpler design. To replace the multiple log capabilities of the wellLog data object, a new data object, named objectGroup, provides a way to group logs together, for example, for multi-pass well testing.
• Removed the realTime data object, replacing it with the simplified functionality of a requestLatestValues option.
• Added a changeLog object, a server object designed to help clients more easily determine which objects in a WITSML server have changed. Clients can query a single object type, the changeLog object, (instead of each individual data object), which also helps reduce server load.
• Specified clear data truncation results behavior so that servers can better manage the volume of data returned and clients have a clear way to request the additional data.
• Identified and developed templates for standard queries, which must be supported by all WITSML v1.4.1 servers.
• Added support for data compression.
• Added a required mechanism for a client to identify itself (software name) to a server using the HTTP user-agent field.
• Developed and refined standard error messages (or return values), which provide more explicit descriptions of errors within the context of specific WITSML functions.
• Revised API document to clearly state server behavior, client behavior (in interacting with a WITSML server) and related error messages. Implemented standard language conventions for specifying this behavior. Added more mandatory server behavior to help improve operational consistency across WITSML servers.
• Revised API document, including organization, format/layout, and language. Added more cross references within the sections with links to related content.

PREVIOUS VERSION IN USE

Further development of Version 1.3.1 is not planned. New production implementations should use Version 1.4.1.

WITSML stimjob object v1.0.0a specification

The stimJob object enables fracturing treatment post job reporting, including: what was pumped, how it was pumped, observations made during the job, and summary interpretations of observed data.

This specification includes the normative data schemas and non-normative examples and usage guide.

This data object is a standalone specification which is not part of, but is compatible with, version 1.3.1.1 of the WITSML standards.  This data object will be incorporated into version 1.4.1 at which point there may be changes to ensure compatibility with 1.4.1.  

NOTE: Further review of this specification revealed that extensionNameValue elements were mistakenly omitted from the specifications originally published.  The above-referenced specifications were corrected effective November 23, 2010 as version 1.0.0a.  Downloads prior to November 23, 2010 should be discarded.

WITSML 1.3.1 Addendum

The WITSML 1.3.1 addendum is intended to help clarify version 1.3.1 and should be read by anyone intending to implement 1.3.1. in addition to the published standards (below). 

Version 1.3.1 is the current, widely implemented, version of the WITSML standards. (See "Version History" for information about previous versions.)

WITSML Data Schema Specifications, Version 1.3.1.1 (bugfix)

WITSML API Specifications, version 1.3.1