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.

Requirements

The following sub-sections define the mandatory and optional requirements for an OSLC Quality Management (OSLC QM) server.

Base Requirements

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.

An OSLC QM server MUST implement the domain vocabulary defined in OSLC Quality Management Version 2.1. Part 2: Vocabulary

The following table summarizes the requirements from OSLC Core Specification 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 to get further details on each of these requirements.

Requirement	Meaning
Unknown properties and content	OSLC services MAY ignore unknown content and OSLC clients MUST preserve unknown content
Resource Operations	OSLC service MUST support resource operations via standard HTTP operations
Resource Paging	OSLC services MAY provide paging for resources but only when specifically requested by client
Partial Resource Representations	OSLC services MUST support request for a subset of a resource’s properties via the oslc.properties URL parameter retrieval via HTTP GET
Partial Update	OSLC services MAY support partial update of resources using patch semantics and MAY support via HTTP PUT
Discovery	OSLC servers MUST support OSLC Core 3.0 Discovery, MAY provide a ServiceProviderCatalog and SHOULD provide a ServiceProvider resource for Core v2 compatibility.
Creation Factories	OSLC servers MUST provide LDPC creation factories to enable resource creation of Quality Management resources via HTTP POST
Query Capabilities	OSLC servers MUST provide query capabilities to enable clients to query for resources
Query Syntax	OSLC query capabilities MUST support the OSLC Core Query Syntax and MAY use other query syntax
Delegated UI Dialogs	OSLC Services MUST offer delegated UI dialogs (creation and selections) specified via OSLC Core 3.0 Delegated Dialogs and SHOULD include discovery through a ServiceProvider resource for OSLC v2 compatibility
UI Preview	OSLC Services 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 resource for OSLC v2 compatibility
HTTP Basic Authentication	OSLC Services MAY support Basic Auth and should do so only over HTTPS
OAuth Authentication	OSLC Services SHOULD support OAuth and can indicate the required OAuth URLs via the ServiceProviderCatalog or ServiceProvider resources
Error Responses	OSLC Services SHOULD provide error responses using OSLC Core 3.0 defined error formats
Turtle Representations	OSLC services MUST provide a Turtle representation for HTTP GET requests and SHOULD support Turtle representations on POST and PUT requests.
RDF/XML Representations	OSLC services SHOULD provide an RDF/XML representation for HTTP GET requests and SHOULD support RDF/XML representations on POST and PUT requests
XML Representations	OSLC services SHOULD provide a XML representation for HTTP GET, POST and PUT requests that conform to the Core 2.0 Guidelines for XML.
JSON Representations	OSLC services MUST provide JSON-LD representations for HTTP GET, POST and PUT requests that conform to the Core Guidelines for JSON-LD
HTML Representations	OSLC services SHOULD provide HTML representations for HTTP GET requests
QM 1.0 response compatibility	OSLC QM servers MAY use `application/x-oslc-qm-*` media types in responses for compatibility with [[!OSLCQM1]]

Specification Versioning

This specification follows the specification version guidelines given in OSLC Core Version 3.0. Part 1: Overview ([[!OSLCCore3]], section 5). There are no substantive changes from OSLC Quality Management Specification Version 2.0 [[OSLCQM2]]. All changes are all upward compatible additions and do not introduce incompatibilities with Version 2.0.

Namespaces

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:

oslc_cm : http://open-services.net/ns/cm# [[OSLCCM20]]
oslc_rm : http://open-services.net/ns/rm# [[OSLCRM20]]

Resource Formats

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,

QM servers MUST provide Turtle and JSON-LD, and SHOULD 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 clients requesting RDF/XML SHOULD 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 servers SHOULD support an [X]HTML representation and a user interface (UI) preview as defined by UI Preview Guidance

For HTTP PUT/POST request formats for resource type of TestPlan, TestCase, TestScript, TestExecutionRecord and TestResult :

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.

For HTTP GET response formats for Query requests,

QM servers MUST provide Turtle and JSON-LD, SHOULD provide RDF/XML, XML, and MAY provide Atom Syndication Format XML representations.

When QM clients request:

text/turtle QM servers MUST respond with Turtle representation.
application/ld+json QM servers MUST respond with JSON-LD representation.
application/rdf+xml QM servers SHOULD respond with RDF/XML representation without restrictions.
application/xml QM servers SHOULD respond with OSLC-defined abbreviated XML representation as defined in the OSLC Core Representations Guidance
application/atom+xml QM servers MAY support Atom Syndication Format XML representation as defined in the OSLC Core Representations Guidance to maintain integrations with the legacy applications.
The Atom Syndication Format XML representation SHOULD use RDF/XML representation without restrictions for the atom:content entries representing the resource representations.

See Query Capabilities for additional information when Resource Shapes affect representation.

Content Negotiation

[[!OSLCCore3]] specifies RDF representations (and specifically Turtle and JSON-LD) as a convention that all OSLC server implementations minimally provide and accept. OSLC QM server implementations are strongly encouraged to adopt this convention. Future versions of this specification are expected to require RDF representations for all operations and relax requirements for specialized XML representations.

XML Representation - identified by the application/xml content type. Format representation rules are outlined in Core OSLC Core Resource Formats section

RDF/XML Representation - identified by the application/rdf+xml content type. No additional guidance is given.

JSON-LD Representation - identified by the application/ld+json content type. Format representation rules are specified in JSON-LD 1.0.

Atom Syndication Format XML Representation - identified by the application/atom+xml content type. Format representation rules are outlined in Core OSLC Core Resource Formats section.

Authentication

[[!OSLCCore3]] specifies the recommended OSLC authentication mechanisms. In addition to the OSLC Core authentication requirements, OSLC QM services providers SHOULD support [[!OpenIDConnect]].

Error Responses

[[!OSLCCore3]] specifies the OSLC Core error responses. OSLC QM puts no additional constraints on error responses.

Pagination

OSLC QM servers SHOULD support pagination of query results and MAY support pagination of a single resource's properties as defined by [[!OSLCCore3]].

Requesting and Updating Properties

Requesting a Subset of Properties

A client MAY request a subset of a resource's properties as well as properties from a referenced resource. In order to support this behavior a server MUST support the oslc.properties and oslc.prefix URL parameter on a HTTP GET request on individual resource request or a collection of resources by query. If the oslc.properties parameter is omitted on the request, then all resource properties MUST be provided in the response.

Updating a Subset of Properties

A client MAY request that a subset of a resource's properties be updated by using the [[LDPPatch]] PATCH method.

For compatibility with [[!OSLCCore2]], QM servers MAY also support partial update by identifying those properties to be modified using the oslc.properties URL parameter on a HTTP PUT request.

If the parameter oslc.properties contains a valid resource property on the request that is not provided in the content, the server MUST set the resource's property to a null or empty value. If the parameter oslc.properties contains an invalid resource property, then a 409 Conflict MUST be returned.

Updating Multi-Valued Properties

For multi-valued properties that contain a large number of values, it may be difficult and inefficient to add or remove property values. OSLC QM servers SHOULD provide support for a partial update of the multi-valued properties as defined by OSLC Core Partial Update.

Labels for Relationships

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:

The property: OSLC recommends using the rdfs:label property of the rdf:Property from the vocabulary to display the property.
The value, or object of the triple: OSLC recommends using OSLC resource preview [[!OSLCPreview]] to obtain an appropriate icon and label, and possibly a small and/or large dialog for displaying the object.
The link: The link is a combination of the subject, predicate and object of the triple (RDF statement or assertion). In the case where the link requires a unique label that is not available from the target resource, only then OSLC servers may support a dcterms:title on a reified statement to provide a label for a link that describes the assertion itself.

Turtle example using a reified statement:

@prefix ns0: <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/tests/4321>
  a <http://open-services.net/ns/qm#TestCase> ;
  ns0:uses <http://anotherexample.com/testscript/123> .

<http://njh.me/#link1>
  a rdf:Statement ;
  rdf:subject <http://example.com//4321> ;
  rdf:predicate ns0:uses ;
  rdf:object <http://anotherexample.com/testscript/123> ;
  dcterms:title "Test Script 123: " .

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"
  }
}

QM Server Capabilities

Resource Shapes

OSLC QM servers SHOULD support Resource Shapes as defined in [[!OSLCShapes]].

Service Provider Resources

OSLC QM servers MUST support OSLC Discovery capabilities defined by [[!OSLCCore3]].

OSLC domain-name servers MAY provide a ServiceProvider Resource that can be retrieved at a implementation dependent URI.

OSLC QM servers MAY provide a ServiceProviderCatalog Resource that can be retrieved at a implementation dependent URI.

OSLC QM servers MAY provide a oslc:serviceProvider property for their defined resources that will be the URI to a ServiceProvider Resource.

OSLC QM servers MUST supply a value of http://open-services.net/ns/qm# for the property oslc:domain on either oslc:Service or oslc:ServiceProviderCatalog resources.

Creation Factories

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]].

Query Capabilities

OSLC QM servers SHOULD support the Query Capabilities as defined by [[!OSLCCore3]]. OSLC QM servers SHOULD support Resource Shapes for Query Capability as defined in [[!OSLCShapes]].

The Query Capability, if supported, MUST support these parameters:

oslc.where
oslc.select
oslc.properties
oslc.prefix

If shape information is NOT present with the Query Capability, servers SHOULD use these default properties to contain the result:

For RDF/XML and XML, use rdf:Description and rdfs:member as defined in OSLC Core RDF/XML Examples.
For JSON, the query results are contained within oslc:results array. See OSLC Core Representation Guidance for JSON

Delegated UIs

OSLC QM servers MUST support the selection and creation of resources by delegated web-based user interface delegated dialogs Delegated as defined by [[!OSLCCore3]].

OSLC QM servers MAY support the pre-filling of creation dialogs based on the definition [[!OSLCCore3]].

Item	V2 status	V3 status	Remark
01	Service Provider Compliance requirements are listed	These requirements appear to be hosted under the heading of Discovery	No action
03	Query MUST scope limited to oslc.where and oslc.select	Query MUST scope extended oslc.properties and oslc.prefix	No action
04	V1 compatibility included	V1 compatibility not included	No action

Revision	Date	Editor	Changes Made
CSPRD01 (not published)	2018-08-08	Jim Amsden and Gray Bachelor	Initial CSPRD01 for V2.1
PSD02	2019-11-14	Andrii Berezovskyi	Migration to the OASIS OSLC Open Project Publication of the vocabulary and shapes
PS01	2020-08-27	Andrii Berezovskyi	Split vocabulary and shapes parts as well as reference machine-readable definitions as normative parts of the spec Change shapes base URI Add shapes metadata

Introduction

Overview

Terminology

References