This specification defines the OSLC Quality Management domain, a RESTful web services interface for the management of product, service or software quality artefacts, activities, tasks and relationships between those and related resources such as requirements, defects, change requests or architectural resources. To support these scenarios, this specification defines a set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, content type handling and resource formats.
TC members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list oslc-domains-comment@lists.oasis-open.org, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/oslc-domains/.
This specification is being provided under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/oslc-domains/ipr.php).
Note that any machine-readable content (Computer Language Definitions) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product's prose narrative document(s), the content in the separate plain text file prevails.
[OSLC-QM-2.1-Part1]
OSLC Quality Management Version 2.1. Part 1: Specification.
Edited by Jim Amsden and Gray Bachelor.
30 March 2025.
OASIS Committee Specification Draft 01 / Public Review Draft 01.
http://docs.oasis-open.org/oslc-domains/qm/v2.1/csprd01/part1-quality-management-spec/qm-v2.1-csprd01-part1-quality-management-spec.html.
Latest version: http://docs.oasis-open.org/oslc-domains/qm/v2.1/qm-v2.1-part1-quality-management-spec.html.
Copyright © OASIS Open 2025. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.
The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.
This section is non-normative.
This specification builds on the OSLC Core Specification [OSLCCore3] to define the resources and operations supported by an Open Services for Lifecycle Collaboration (OSLC) Quality Management (QM) provider.
Quality Management resources define the test plans, test cases, and test results of the software delivery lifecycle. They represent individual resources along with their relationships to other shared resource types such change requests and requirements. The intent of this specification is to define the set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, mime type handling and resource formats. The capabilities of the interface definitions are driven by key integration scenarios and therefore don't represent a complete setup of operations on resources or resource types. The resource formats and operations may not match exactly the native models supported by quality management service providers but are intended to be compatible with them.
A key approach to supporting these scenarios is to delegate operations, as driven by service provider contributed user interfaces, as much as possible and not require a service provider to expose its complete data model and application logic.
This Committee Specification Public Review Draft is being developed under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/oslc-domains/ipr.php).
This section is non-normative.
Terminology uses and extends the terminology and capabilities of [OSLCCore3].
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.
The key words MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this specification are to be interpreted as described in [RFC2119].
The following sub-sections define the mandatory and optional requirements for an OSLC Quality Management (OSLC QM) server.
This specification is based on [OSLCCore3]. OSLC QM servers MUST be compliant with both the core specification, MUST follow all the mandatory requirements in the normative sections of this specification, and SHOULD follow all the guidelines and recommendations in both these specifications. [QM-1]
An OSLC QM server MUST implement the domain vocabulary defined in OSLC Quality Management Version 2.1. Part 2: Vocabulary [QM-2]
The following table summarizes the requirements from OSLC Core Specification [OSLCCore3] as well as some additional requirements specific to the QM domain. Note that this specification further restricts some of the requirements for OSLC Core Specification. See subsequent sections in this specification or the OSLC Core Specification [OSLCCore3] to get further details on each of these requirements.
This specification follows the specification version guidelines given in [OSLCCore3].
In addition to the namespace URIs and namespace prefixes oslc
, rdf
, dcterms
and foaf
defined in the [OSLCCore3], OSLC QM defines the namespace URI of http://open-services.net/ns/qm#
with a namespace prefix of oslc_qm
.
This specification also uses these namespace prefix definitions:
In addition to the requirements for resource representations in [OSLCCore3], this section outlines further refinements and restrictions.
For HTTP GET requests on all OSLC QM and OSLC Core defined resource types,
For HTTP PUT/POST request formats for QM resource of type TestPlan, TestCase, TestScript, TestExecutionRecord and TestResult :
For HTTP GET response formats for Query requests,
QM servers MUST provide Turtle and JSON-LD, SHOULD provide RDF/XML, XML, and MUST provide Atom Syndication Format XML representations. [QM-26]
When QM clients request:
text/turtle
QM servers MUST respond with Turtle representation. [QM-27]application/ld+json
QM servers MUST respond with JSON-LD representation. [QM-28]application/rdf+xml
QM servers SHOULD respond with RDF/XML representation without restrictions. [QM-29]application/xml
QM servers SHOULD respond with OSLC-defined abbreviated XML representation as defined in the OSLC Core Representations Guidance [QM-30]application/atom+xml
QM servers SHOULD respond with Atom Syndication Format XML representation as defined in the OSLC Core Representations Guidance [QM-31]See Query Capabilities for additional information when Resource Shapes affect representation.
[OSLCCore3] specifies the recommended OSLC authentication mechanisms. In addition to the OSLC Core authentication requirements, OSLC QM services providers SHOULD support [OpenIDConnect]. [QM-32]
[OSLCCore3] specifies the OSLC Core error responses. OSLC QM puts no additional constraints on error responses.
This section is non-normative.
QM resource relationships to other resources are represented by RDF properties. Instances of a relationship - often called links - are RDF triples with a subject URI, a predicate that is the property, and a value (or object) that is the URI of target resource. When a link is to be presented in a user interface, it may be helpful to display an informative and useful textual label instead of or in addition to the URI of the predicate and or object. There are three items that clients could display:
Turtle example using a reified statement:
@prefix oslc_qm: <http://open-services.net/ns/qm#> . @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix dcterms: <http://purl.org/dc/terms/> . <http://example.com/testcase/4321> a <http://open-services.net/ns/qm#TestCase> ; oslc_qm:usesTestScript <http://anotherexample.com/testscript/123> . <http://njh.me/#link1> a rdf:Statement ; rdf:subject <http://example.com/testcase/4321> ; rdf:predicate ns0:uses ; rdf:object <http://example.com/testscript/123> ; dcterms:title "Test Script 123: Request maximum output " .
JSON-LD example using reified statement:
{ "@context": { "dcterms": "http://purl.org/dc/terms/", "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", "oslc": "http://open-services.net/ns/core#", "oslc_qm": "http://open-services.net/ns/qm#" }, "@id": "http://example.com/testscripts/4321", "@type": "oslc_qm:TestScript", "oslc_cm:relatedChangeRequest": { "@id": "http://anotherexample.com/defects/123", "dcterms:title": "Defect 123: Problems during install" } }
OSLC QM servers SHOULD support Resource Shapes as defined in [OSLCShapes]. [QM-33]
OSLC QM servers MUST support OSLC Discovery capabilities defined by [OSLCCore3]. [QM-34]
OSLC QM servers MUST provide a ServiceProvider Resource that can be retrieved at a implementation dependent URI. [QM-35]
OSLC QM servers MUST provide a ServiceProviderCatalog Resource that can be retrieved at a implementation dependent URI. [QM-36]
OSLC QM servers MAY provide a oslc:serviceProvider
property for their defined resources that will be the URI to a ServiceProvider Resource. [QM-37]
OSLC QM servers MUST support [OSLCCore3] Creation Factories and list them in the Service Provider Resource as defined by OSLC Core. OSLC QM servers SHOULD support Resource Shapes for Creation Factories as defined in [OSLCShapes]. [QM-38]
OSLC QM servers MUST support the Query Capabilities as defined by [OSLCCore3]. OSLC QM servers SHOULD support Resource Shapes for Query Capability as defined in [OSLCShapes]. [QM-39]
The Query Capability, if supported, MUST support these parameters: [QM-40]
If shape information is NOT present with the Query Capability, servers SHOULD use these default properties to contain the result: [QM-43]
rdf:Description
and rdfs:member
as defined in OSLC Core RDF/XML Examples.oslc:results
array. See OSLC Core Representation Guidance for JSONOSLC QM servers MAY support the selection and creation of resources by delegated web-based user interface delegated dialogs Delegated as defined by [OSLCCore3]. [QM-44]
OSLC QM servers MAY support the pre-filling of creation dialogs based on the definition [OSLCCore3]. [QM-45]
Implementations of this specification need to satisfy the following conformance clauses.
Clause Number | Requirement |
---|---|
QM-1 | This specification is based on [OSLCCore3]. OSLC QM servers MUST be compliant with both the core specification, MUST follow all the mandatory requirements in the normative sections of this specification, and SHOULD follow all the guidelines and recommendations in both these specifications. |
QM-2 | An OSLC QM server MUST implement the domain vocabulary defined in OSLC Quality Management Version 2.1. Part 2: Vocabulary |
QM-3 | OSLC servers MAY ignore unknown content and OSLC clients MUST preserve unknown content |
QM-4 | OSLC service MUST support resource operations via standard HTTP operations |
QM-5 | OSLC servers MAY provide paging for resources but only when specifically requested by client |
QM-6 | OSLC servers MUST support request for a subset of a resource’s properties via the oslc.properties URL parameter retrieval via HTTP GET |
QM-7 | OSLC services MAY support partial update of resources using patch semantics and MAY support update via HTTP PUT |
QM-8 | OSLC servers MAY provide a Service Provider Catalog, MUST provide a Service Provider resource, and MAY provide other forms of discovery described in Core 3.0 Discovery. |
QM-9 | OSLC servers MAY provide LDPC creation factories to enable resource creation of Quality Management resources via HTTP POST |
QM-10 | OSLC servers MUST provide query capabilities to enable clients to query for resources |
QM-11 | OSLC query capabilities MUST support the OSLC Core Query Syntax and MAY use other query syntax |
QM-12 | OSLC servers MUST offer delegated UI dialogs (creation and selections) specified via OSLC Core 3.0 Delegated Dialogs and SHOULD include discovery through a ServiceProvider resource and catalog for OSLC v2 compatibility |
QM-13 | OSLC servers SHOULD offer UI previews for resources that may be referenced by other resources specified via OSLC Core 3.0 Preview and SHOULD include discovery through a server catalog resource for OSLC v2 compatibility |
QM-14 | OSLC servers MAY support Basic Auth and SHOULD do so only over HTTPS |
QM-15 | OSLC servers MAY support OAuth and can indicate the required OAuth URLs via the ServiceProviderCatalog or ServiceProvider resources |
QM-16 | OSLC servers MAY provide error responses using OSLC Core 3.0 defined error formats |
QM-17 | OSLC servers MAY provide a Turtle representation for HTTP GET requests and SHOULD support Turtle representations on POST and PUT requests. |
QM-18 | OSLC servers MUST provide an RDF/XML representation for HTTP GET requests and SHOULD support RDF/XML representations on POST and PUT requests |
QM-19 | OSLC servers MAY provide a XML representation for HTTP GET, POST and PUT requests that conform to the Core 2.0 Guidelines for XML. |
QM-20 | OSLC servers MAY provide JSON-LD representations for HTTP GET, POST and PUT requests that conform to the Core Guidelines for JSON-LD |
QM-21 | OSLC servers SHOULD provide HTML representations for HTTP GET requests |
QM-22 | QM servers MAY provide Turtle and JSON-LD, and MUST provide RDF/XML and XML representations. The XML and JSON representations SHOULD follow the guidelines outlined in the OSLC Core Representations Guidance to maintain compatibility with [OSLCCore2]. |
QM-23 | QM clients requesting RDF/XML MUST be prepared for any valid RDF/XML document. QM clients requesting XML SHOULD be prepared for representations that follow the guidelines outlined in the OSLC Core Representations Guidance. |
QM-24 | QM servers SHOULD support an [X]HTML representation and a user interface (UI) preview as defined by UI Preview Guidance |
QM-25 | QM servers MUST accept Turtle and JSON-LD representations and SHOULD accept RDF/XML and XML representations. QM servers accepting RDF/XML SHOULD be prepared for any valid RDF/XML document. For XML, QM servers SHOULD be prepared for representations that follow the guidelines outlined in the OSLC Core Representations Guidance. |
QM-26 | QM servers MUST provide Turtle and JSON-LD, SHOULD provide RDF/XML, XML, and MUST provide Atom Syndication Format XML representations. |
QM-27 | text/turtle QM servers MUST respond with Turtle representation. |
QM-28 | application/ld+json QM servers MUST respond with JSON-LD representation. |
QM-29 | application/rdf+xml QM servers SHOULD respond with RDF/XML representation without restrictions. |
QM-30 | application/xml QM servers SHOULD respond with OSLC-defined abbreviated XML representation as defined in the OSLC Core Representations Guidance |
QM-31 | application/atom+xml QM servers SHOULD respond with Atom Syndication Format XML representation as defined in the OSLC Core Representations Guidance |
QM-32 | [OSLCCore3] specifies the recommended OSLC authentication mechanisms. In addition to the OSLC Core authentication requirements, OSLC QM services providers SHOULD support [OpenIDConnect]. |
QM-33 | OSLC QM servers SHOULD support Resource Shapes as defined in [OSLCShapes]. |
QM-34 | OSLC QM servers MUST support OSLC Discovery capabilities defined by [OSLCCore3]. |
QM-35 | OSLC QM servers MUST provide a ServiceProvider Resource that can be retrieved at a implementation dependent URI. |
QM-36 | OSLC QM servers MUST provide a ServiceProviderCatalog Resource that can be retrieved at a implementation dependent URI. |
QM-37 | OSLC QM servers MAY provide a oslc:serviceProvider property for their defined resources that will be the URI to a ServiceProvider Resource. |
QM-38 | OSLC QM servers MUST support [OSLCCore3] Creation Factories and list them in the Service Provider Resource as defined by OSLC Core. OSLC QM servers SHOULD support Resource Shapes for Creation Factories as defined in [OSLCShapes]. |
QM-39 | OSLC QM servers MUST support the Query Capabilities as defined by [OSLCCore3]. OSLC QM servers SHOULD support Resource Shapes for Query Capability as defined in [OSLCShapes]. |
QM-40 | The Query Capability, if supported, MUST support these parameters: |
QM-41 | oslc.where |
QM-42 | oslc.select |
QM-43 | If shape information is NOT present with the Query Capability, servers SHOULD use these default properties to contain the result: |
QM-44 | OSLC QM servers MAY support the selection and creation of resources by delegated web-based user interface delegated dialogs Delegated as defined by [OSLCCore3]. |
QM-45 | OSLC QM servers MAY support the pre-filling of creation dialogs based on the definition [OSLCCore3]. |
A number of terms introduced in early development of the OSLC QM domain that were deprecated in the finalized V2.0. These terms are summarized here in order to indicate they remain deprecated in V2.1.
Prefixed Name | Occurs | Read-only | Value-type | Represen-tation | Range | Description |
---|---|---|---|---|---|---|
deprecated dcterms:type | zero-or-more | unspecified | String | n/a | n/a | A short string representation for the type, example Defect . |
Relationship properties: This grouping of properties are used to identify relationships between resources managed by other OSLC servers | ||||||
deprecated oslc_cm:testedByTestCase | zero-or-many | False | Resource | Reference | any | Test case by which this Change Request is tested. It is likely that the target resource will be an oslc_qm:TestCase, but that is not necessarily the case. |
deprecated oslc_cm:affectsTestResult | zero-or-many | False | Resource | Reference | any | Associated QM resource that is affected by this Change Request. It is likely that the target resource will be an oslc_qm:TestResult, but that is not necessarily the case. |
deprecated oslc_cm:blocksTestExecutionRecord | zero-or-many | False | Resource | Reference | any | Associated QM resource that is blocked by this Change Request. It is likely that the target resource will be an oslc_cm:TestExecutionRecord, but that is not necessarily the case. |
For a resource format identification of RDF/XML and XML, the media type used for this representation SHOULD be application/rdf+xml or application/xml. The usage of the OSLC QM 1.0 defined media types of application/x-oslc-qm-* is being deprecated.
QM 1.0 consumers wanting to request 1.0 resource formats will not need to change if they used 1.0 defined media types ( application/x-oslc-qm*), see OSLC-QM 1.0. QM 2.0 consumers should use media types as defined in this specification for requests, excluding the OSLC QM 1.0 specific media types ( application/x-oslc-qm*). QM consumers supporting both 1.0 and 2.0, may request request both 1.0 and 2.0 media types on HTTP GET requests as usually done with HTTP request parameter Accept giving appropriate quality (See HTTP Accept) weighting to help distinguish their preferred content.
For additional guidance, a QM 2.0 consumer or provider MAY reference the OSLC-Core-Version HTTP header with a value of 2.0.
There are no substantive changes from OSLC QM Specification 2.0. This document is a document maintenance update of the version 2.0 document to support migration from open-services.net to OASIS.The changes are all upward compatible additions and therefore do not introduce incompatibilities with version 2.0.
Specific ommissions for Turtle and JSO were included in Section 2.1 and 2.4.
Clarification over OSLC Core 2.0 Discovery difference with OSLC Core 3.0 in Section 2.1, 4.2 and 4.4.
This section is non-normative.
The following individuals have participated in the creation of the V2.0 specification and are gratefully acknowledged:
Participants:
Gray Bachelor (IBM - Editor)
Dave Johnson (IBM)
Ingrid Jorgensen (Tieto)
Michael Pena (Sogeti)
Nigel Lawrence (IBM)
Paul McMahan (IBM, OSLC-QM Lead)
Scott Bosworth (IBM)
Scott Fairbrother (IBM)
Jim Amsden (IBM)
Jad El Khoury (KTH)
This section is non-normative.
Revision | Date | Editor | Changes Made |
05 | 18/01/2018 | Gray Bachelor | Finalise after closing issues |