This document was last revised or approved by the OASIS Open Services for Lifecycle Collaboration (OSLC) OP on the above date. The level of approval is also listed above. Check the “Latest stage” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Open Project are listed at https://github.com/oslc-op/oslc-specs.
Comments on this work can be provided by opening issues in the project repository or by sending email to the project’s public comment list oslc-op.
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-CoreShapes-3.0]
OSLC Core Version 3.0. Part 8: Constraints.
Edited by Jim Amsden.
17 September 2020.
OASIS Project Specification 01.
https://docs.oasis-open-projects.org/oslc-op/core/v3.0/ps01/core-shapes.html.
Latest stage: https://docs.oasis-open-projects.org/oslc-op/core/v3.0/core-shapes.html.
Copyright © OASIS Open 2020. 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 specification is published under the Attribution 4.0 International (CC BY 4.0). Portions of this specification are also provided under the Apache License 2.0.
All contributions made to this project have been made under the OASIS Contributor License Agreement (CLA).
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 Open Projects IPR Statements page.
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 Open Project or 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 Project Specification or OASIS Standard, to notify the 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 Open Project 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 Open Project 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.
RDF vocabularies define the terms and resources for a domain of interest, life-cycle management in the case of OSLC Core. These vocabularies are often specified in an open manner, without providing information such as property domain and range assertions, cardinalities, etc. This helps keep the vocabulary applicable for a wide range of uses and furthering integration with other vocabularies.
However, it is often desirable to closed down a vocabulary with specific constraints to facilitate using the vocabulary for a specific purpose. This document specifies the constraints for using the OSLC Core vocabulary in OSLC. Different sets of constraints may be applied to a vocabulary in order to tailor its use, without overly constraining the vocabulary for other usages.
These constraints apply to the core vocabulary defined in OSLC Core Version 3.0. Part 7: Vocabulary.
Terminology uses and extends the terminology and capabilities of OSLC Core Overview, W3C Linked Data Platform [LDP], W3C's Architecture of the World Wide Web [WEBARCH], Hyper-text Transfer Protocol [HTTP11].
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 shape of an RDF resource is a description of the set of triples it is expected to contain and the integrity constraints those triples are required to satisfy. Applications of shapes include validating RDF data, documenting RDF APIs, and providing meta-data to tools, such as form and query builders, that handle RDF data. OSLC Core uses shapes to:
Constraints on OSLC Core and Domain resources SHOULD be described using ResourceShapes which is included as part of the OSLC Core multi-part specifications. Servers MAY use other constraint languages such as [SHACL] to define resource constraints.
Unlike the rest of the Core specification, these properties change and grow as new common properties are added. The properties that we list here are available for use in OSLC domain specifications when defining OSLC resources, but this does not mean that they are required to be in OSLC resources. OSLC domain specifications decide which properties are allowed and required for resources needed to realize their use cases. The OSLC common properties include properties defined in other standard vocabularies including:
Common Properties
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
dcterms:contributor |
Zero-or-many | unspecified | AnyResource | Either | oslc:Any , foaf:Person |
Contributor or contributors to the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case. |
dcterms:created |
Zero-or-one | unspecified | dateTime | N/A | Unspecified | Timestamp of resource creation. |
dcterms:creator |
Zero-or-many | unspecified | AnyResource | Either | oslc:Any , foaf:Person |
Creator or creators of the resource. It is likely that the target resource will be a foaf:Person but that is not necessarily the case. |
dcterms:description |
Zero-or-many | unspecified | XMLLiteral | N/A | Unspecified | Descriptive text about resource represented as rich text in XHTML content. |
dcterms:identifier |
Zero-or-many | unspecified | string | N/A | Unspecified | A unique identifier for a resource. Typically read-only and assigned by the service provider when a resource is created. Not typically intended for end-user display. |
dcterms:modified |
Zero-or-many | unspecified | dateTime | N/A | Unspecified | Timestamp of latest resource modification. |
dcterms:references |
Zero-or-many | unspecified | AnyResource | Either | Unspecified | A related resource that is referenced, cited, or otherwise pointed to by the described resource. |
dcterms:relation |
Zero-or-many | unspecified | AnyResource | Either | Unspecified | Relation which identifies a related resource. |
dcterms:subject |
Zero-or-many | unspecified | string | N/A | Unspecified | Tag or keyword for a resource. Each occurrence of a dcterms:subject property denotes an additional tag for the resource. |
dcterms:title |
Zero-or-many | unspecified | XMLLiteral | N/A | Unspecified | Title of the resource represented as rich text in XHTML content. |
oslc:archived |
Zero-or-one | unspecified | boolean | N/A | Unspecified | Indicates whether the subject has been marked as archived, no longer an actively updating resource. |
oslc:discussedBy |
Zero-or-one | unspecified | Resource | Either | oslc:Discussion |
A series of notes and comments about this resource. |
oslc:error |
Zero-or-many | unspecified | AnyResource | Either | Unspecified | A series of errors associated with this resource. |
oslc:instanceShape |
Zero-or-many | unspecified | Resource | Reference | oslc:ResourceShape |
The URI of a Resource Shape that describes the possible properties, occurrence, value types, allowed values and labels. This shape information is useful in displaying the subject resource as well as guiding clients in performing modifications. Instance shapes may be specific to the authenticated user associated with the request that retrieved the resource, the current state of the resource and other factors and thus should not be cached. |
oslc:modifiedBy |
Zero-or-many | unspecified | Resource | Either | oslc:Any , foaf:Person |
The URI of a resource describing the entity that most recently modified the subject resource. The link target is usually a foaf:Person or foaf:Agent, but could be any type. This is modeled after dcterms:creator, but Dublin Core currently has no equivalent property. |
oslc:queryable |
Zero-or-one | unspecified | boolean | N/A | Unspecified | Indicates whether a property is queryable (can appear in oslc.where and olsc.select clause) or not. Defaults to true if unspecified. |
oslc:serviceProvider |
Zero-or-many | unspecified | Resource | Reference | oslc:ServiceProvider |
A link to the resource's OSLC Service Provider. There may be cases when the subject resource is available from a service provider that implements multiple domain specifications, which could result in multiple values for this property. |
oslc:shortId |
Zero-or-many | unspecified | string | N/A | Unspecified | A short, human-readable, plain text value. This value should be unique in some context that is apparent to human users of a service. |
oslc:shortTitle |
Zero-or-many | unspecified | XMLLiteral | N/A | Unspecified | Shorter form of dcterms:title for the resource represented as rich text in XHTML content. |
rdf:type |
Zero-or-many | unspecified | Resource | Reference | rdfs:Class |
The resource type URIs. |
rdfs:member |
Zero-or-many | unspecified | Resource | Either | Unspecified | OSLC domains might define a number of member or contains relationships between resources. The rdfs:member property is suitable for use when only one such relationship needs to be defined, or when no additional semantics need to be implied by the property name. |
http://xmlns.com/foaf/0.1/Person
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
foaf:familyName |
Zero-or-many | unspecified | string | N/A | Unspecified | Family name of person expressed as simple text string. |
foaf:givenName |
Zero-or-many | unspecified | string | N/A | Unspecified | Given name of person expressed as simple text string. |
foaf:mbox |
Zero-or-many | unspecified | string | N/A | Unspecified | A personal mailbox for this person, typically identified using the mailto: URI scheme (see RFC 2368). |
foaf:name |
Zero-or-many | unspecified | string | N/A | Unspecified | The full name of a person expressed as simple text string. |
foaf:nick |
Zero-or-many | unspecified | string | N/A | Unspecified | A short informal nickname or login identifer expressed as simple text string. |
http://open-services.net/ns/core#
.
It is common to collect a series of comments on a lifecycle resource, often referred to as a discussion. For example: tasks, bug reports, requirements, assets and so on, are often collected across various types of resources such as project. A project might reflect the planning of work to deliver a product that realizes the requirements as validated through test cases and bug reports. Discussions allow users to collaborate with each other for more efficient and effective delivery. This Discussion resource definition provides a minimal shape describing the needed properties.
http://open-services.net/ns/core#Discussion
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
oslc:comment |
Zero-or-many | false | AnyResource | Either | oslc:Comment |
Comment about resource. |
oslc:discussionAbout |
Exactly-one | false | Resource | Reference | Unspecified | Reference to associated resource. |
Used in conjunction with Shape: Discussion to provide a minimal resource definition for a collection of comments.
http://open-services.net/ns/core#Comment
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
dcterms:created |
Exactly-one | unspecified | dateTime | N/A | Unspecified | When the comment resource was created. |
dcterms:creator |
Exactly-one | unspecified | AnyResource | Either | foaf:Person |
The person who created the comment. |
dcterms:description |
Exactly-one | unspecified | XMLLiteral | N/A | Unspecified | Details or body of the comment. SHOULD include only content that is valid and suitable inside an XHTML <div> element. |
dcterms:identifier |
Exactly-one | unspecified | string | N/A | Unspecified | A service defined identifier. |
dcterms:title |
Zero-or-one | unspecified | XMLLiteral | N/A | Unspecified | A brief title for the comment. SHOULD include only content that is valid and suitable inside an XHTML <span> element. |
oslc:inReplyTo |
Zero-or-one | unspecified | Resource | Reference | oslc:Comment |
Reference to the comment to which this comment replies. |
Accept
request header. [HTTP11]
oslc:statusCode
as a String that starts with digits, but may
contain non-digit text.
Used when servers may need a consistent shape to communicate error messages.
http://open-services.net/ns/core#Error
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
dcterms:created |
Zero-or-one | unspecified | dateTime | N/A | Unspecified | Optional indication of when the error was detected. |
dcterms:identifier |
Zero-or-many | unspecified | string | N/A | Unspecified | A unique human-readable string identifier for this resource, such as an error number or code. |
dcterms:references |
Zero-or-many | unspecified | AnyResource | Either | Unspecified | A reference to any resources that are the subject of this error. |
oslc:extendedError |
Zero-or-one | true | AnyResource | Either | oslc:ExtendedError |
Extended error information. |
oslc:message |
Exactly-one | true | string | N/A | Unspecified | An informative message describing the error that occurred. |
oslc:statusCode |
Exactly-one | true | string | N/A | Unspecified | The HTTP status code reported with the error. |
Additional details about an error the server had when processing the request.
http://open-services.net/ns/core#ExtendedError
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
oslc:hintHeight |
Zero-or-one | true | string | N/A | Unspecified | Values MUST be expressed in relative length units as defined in the W3C Cascading Style Sheets Specification (CSS 2.1) Em and ex units are interpreted relative to the default system font (at 100% size). |
oslc:hintWidth |
Zero-or-one | true | string | N/A | Unspecified | Values MUST be expressed in relative length units as defined in the W3C Cascading Style Sheets Specification (CSS 2.1) Em and ex units are interpreted relative to the default system font (at 100% size). |
oslc:moreInfo |
Zero-or-one | true | Resource | Reference | Unspecified | A resource giving more information on the error SHOULD be of an HTML content-type. |
oslc:rel |
Zero-or-one | true | string | N/A | Unspecified | If present and set to 'alternate' then indicates that work-around is provided, behavior for other values is undefined. |
Resource representations returned via [OSLCCore2] Resource Paging MUST include a resource of type oslc:ResponseInfo, as defined in this section. A response info resource representation describes information about a paged HTTP response body in which it appears.
http://open-services.net/ns/core#ResponseInfo
Prefixed Name | Occurs | Read-only | Value-type | Representation | Range | Description |
---|---|---|---|---|---|---|
dcterms:description |
Zero-or-one | unspecified | XMLLiteral | N/A | Unspecified | Descriptive text about resource represented as rich text in XHTML content. |
dcterms:title |
Zero-or-one | unspecified | XMLLiteral | N/A | Unspecified | Title of the resource represented as rich text in XHTML content. |
oslc:nextPage |
Zero-or-one | true | Resource | Reference | Unspecified | Link to the next page of a response. |
oslc:postBody |
Zero-or-one | true | string | N/A | Unspecified | The body of a POST request to return the next page if the response was to a POST request. Where a paged resource supports POST with an application/x-www-form-urlencoded body as an alternative to GET to avoid the request URI exceeding server limitations, the oslc:ResponseInfo in the response to the POST SHOULD contain this property so that a client knows what to POST to get the next page. |
oslc:totalCount |
Zero-or-one | true | integer | N/A | Unspecified | This optional property indicates the total number of results across all pages, its value should be non-negative. In the context of a query resource, this value SHOULD be the total number of results, i.e. the number of resources that match the query. In the context of other resources, the value SHOULD be the total number of property values (i.e. RDF triples) of the resource. Unless Stable Paging is in effect, the total count MAY vary as a client retrieves subsequent pages. |
OSLC servers MUST follow the constraints defined here where required, and with the meanings defined here.
OSLC servers MAY provide additional constraints for specific purposes.