This specification defines the OSLC SysML domain, a RESTful web services interface for the SysML v2 resources and relationships between those and related resources such as product change requests, activities, tasks, requirements or test cases. To support these scenarios, this specification defines a set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, as well as HTTP response codes, content type handling and resource formats.
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://open-services.net/about/.
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@lists.oasis-open-projects.org.
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-SYSML-2.0-Part1]
OSLC Systems Modeling Language Version 2.0. Part 1: Specification.
Edited by Jim Amsden.
25 April 2024.
OASIS Project Specification Draft 01.
https://docs.oasis-open-projects.org/oslc-op/sysml/v2.0/psd01/sysml-spec.html.
Latest stage: https://docs.oasis-open-projects.org/oslc-op/sysml/v2.0/sysml-spec.html.
Copyright © OASIS Open 2024. 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.
Object Management group (https://www.omg.org) defines the OMG Systems Modeling Language Version 2.0 commonly referred to as SysML v2 [SysML]. From OMG: "SysML is a general-purpose modeling language for modeling systems that is intended to facilitate a model-based systems engineering (MBSE) approach to engineer systems. It provides the capability to create and visualize models that represent many different aspects of a system.This includes representing the requirements, structure, and behavior of the system, and the specification of analysis cases and verification cases used to analyze and verify the system. The language is intended to support multiple systems engineering methods and practices. The specific methods and practices may impose additional constraints on how the language is used."
SysML v2 plays a key role in Model-Based Systems and Software Engineering which is a major part of lifecycle management by defining a representation of the resources whose lifecycles are to be managed. It is therefore highly desirable to be able to integrate and link SysML resources with OSLC resources such as Requirements, Change Requests, Architecture Resources and test cases. This is accomplished by two OSLC-OP initiatives:
This specification defines the RESTful web services interface for the SysML OSLC domain that is used in the PIM to PSM mapping. This domain addresses the management of Model-Based Systems Engineering (MBSE) artifacts such as models, and relationships with other resources such as requirements, testing resources and change requests, as well as relationships between reusable SysML model elements in a supply chain. 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.
The intent of this specification is to define the capabilities needed to support integration scenarios used in typical MBSE methods using SysML v2, and to enable linking SysML model artifacts with other OSLC lifecyle artifacts. This is accomplished by generating the OSLC SysML v2 vocabulary terms and constraints from the SysML Abstract Syntax (XMI), and having http://open-services.net/ns/kerml#Element subclass http://open-services.net/ns/am#Resource [OSLCAM].
This specification is a [OSLCCore3] compliant specification, and as such most of its content are references to [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", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this specification are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
The following sub-sections define the mandatory and optional requirements for an OSLC SysML (OSLC SysML) server.
This specification is based on [OSLCCore3]. OSLC SysML 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. [SML-1]
An OSLC SysML server MUST implement the domain vocabulary defined in OSLC SysML Version 2.1. Part 2: Vocabulary [SML-2]
The following table summarizes the requirements from OSLC Core Specification as well as some additional requirements specific to the SysML domain. Note that this specification further restricts some of the requirements from the OSLC Core Specification. See the previous sections in this specification or the OSLC Core Specification to get further details on each of these requirements.
Requirement | Meaning |
---|---|
Absolute URIs | SysML Servers MUST use absolute URIs for all references to resources by properties [SML-3] |
Unknown properties and content | SysML Servers MAY ignore unknown content and SysML clients MUST preserve unknown content. SysML Servers MAY discard such properties and continue the POST or PUT operation without warning to the client. [SML-4] |
Resource Operations | SysML Servers MUST support resource operations via standard HTTP operations [SML-5] |
Update and Delete | SysML Servers SHOULD support resource modifications with standard HTTP PUT and DELETE methods. SysML Servers MAY limit modifications [SML-6] |
HTTP If-Match use | SysML Servers supporting update and delete of resources MUST support the standard HTTP If-Match header in PUT and DELETE for concurrency protection of resources. [SML-7] |
Resource Paging | SysML Servers MAY provide paging for resources but only when specifically requested by clients [SML-8] |
Partial Resource Representations | SysML Servers MAY support requests for a subset of a resource's properties via the oslc.properties URL parameter retrieval via HTTP GET [SML-9] |
Partial Update | SysML Servers MAY support partial update of resources via the oslc.properties URL parameter retrieval via HTTP PUT and or using [LDPPatch]. [SML-10] |
Discovery | SysML Servers MAY provide a Service Provider Catalog, MUST provide a Service Provider resource, and MAY provide other forms of discovery described in [OSLCCore3]. [SML-11] |
Creation Factories | SysML Servers MAY provide creation factories for resource formats that it supports. SysML Servers MAY support creation factories for OSLC SysML defined resources formatted as application/rdf+xml. SysML Servers MAY support creation factories for other formats, and indicate such creation factories with a non-default identifier in the oslc:usage property of the creation factory definition in the service provider document [SML-12] |
Query Capabilities | SysML Servers MUST provide query capabilities on oslc_am:Resource resources to enable clients to query for resources. SysML Servers SHOULD support a query interface for oslc_am:LinkType resources that support a GET for all LinkType resources. Such a GET does not require any simple query syntax parameters. SysML Servers MAY support the full query syntax for LinkType resources. [SML-13] |
Query Syntax | OSLC query capabilities MUST support the OSLC Core Query Syntax [SML-14] |
Delegated Dialogs | SysML Services SHOULD offer selection delegated dialogs and MAY offer creation delegated dialogs specified via service provider resource [SML-15] |
Resource Preview | SysML Services SHOULD offer resource previews for resources that may be referenced by other resources [SML-16] |
Authentication | SysML Services SHOULD follow the recommendations for Authentication specified in [OSLCCore3] [SML-17] |
Error Responses | SysML Servers SHOULD provide error responses using OSLC Core defined error formats [SML-18] |
RDF/XML Representations | SysML Servers MUST support RDF/XML representations for OSLC Defined Resources [SML-19] |
XML Representations | SysML Servers MUST support XML representations that conform to the OSLC Core Guidelines for XML [SML-20] |
JSON Representations | SysML Servers MAY support JSON representations; those which do MUST conform to the OSLC Core Guidelines for JSON [SML-21] |
HTML Representations | SysML Servers MAY provide HTML representations for GET requests [SML-22] |
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 [OSLCCore3], OSLC SysML defines the namespace URI of
http://open-services.net/ns/sysmlv2#
with a preferred namespace prefix of oslc_am
.
In addition to the requirements for resource representations in [OSLCCore3], this section outlines further refinements and restrictions.
For HTTP GET/PUT/POST requests on all OSLC SysML and OSLC Core defined resource types,
application/rdf+xml
. SysML
Clients SHOULD be prepared to deal with any valid RDF/XML document.
[SML-23]application/xml
. The XML
representations MUST follow the guidelines outlined in the
OSLC Core Representations Guidance
to maintain compatibility with [OSLCCore2].
[SML-24]application/json
. The JSON
representations MUST follow the guidelines outlined in the
OSLC Core Representations Guidance
to maintain compatibility with [OSLCCore2].
[SML-25]For compatibility with OSLC 2.0, OSLC SysML Servers MAY accept the OSLC Core Version header (OSLC-Core-Version: 2.0) in any HTTP request as specified in [OSLCCore3], and return an OSLC SysML 2.0 representation (including the OSLC-Core-Version: 2.0 header). If the OSLC Core Version header is absent on a request, or has some undefined value, the OSLC SysML Server MUST return an SysML 2.0 representation. [SML-26]
OSLC SysML Servers MUST support HTTP GET requests on SysML Resources, with an Accept header of
application/rdf+xml
, and return the RDF/XML representation of the resource.
[SML-27]
OSLC SysML Servers SHOULD support HTTP GET requests on SysML Resources, with an Accept header of an HTML type
( application/html
, application/xhtml
), and return either an HTML/XHTML
representation of the resource or redirect the client to another URL that can (i.e. 302 Redirect).
[SML-28]
OSLC SysML Servers SHOULD support HTTP GET requests for user interface (UI) preview of SysML Resources as defined by [OSLCPreview]. [SML-29]
OSLC SysML Servers SHOULD support resource modifications on SysML Resources with standard HTTP PUT and DELETE methods. SysML Servers MAY limit modifications in any way they want. For example a service provider may limit updates to resources to simple link properties of link types already defined in the provider. Modification methods MUST use the If-Match header for concurrency management. Providers MAY discard such properties and continue a PUT operation without warning to the client. [SML-30]
OSLC SysML Servers SHOULD support resource modifications on LinkType Resources (LTR) with standard HTTP PUT and DELETE methods. SysML Servers MAY limit modifications in any way they want. For example a service provider may not support additional properties. Modification methods SHOULD use the If-Match header for concurrency management. [SML-31]
See [OSLCCore3], OSLC SysML puts no additional constraints on authentication.
See [OSLCCore3], OSLC SysML puts no additional constraints on error responses
OSLC SysML Servers SHOULD support pagination of query results and MAY support pagination of a single resource's properties as defined by [OSLCCore3]. [SML-32]
An OSLC SysML server MAY support the oslc.properties
URL query parameter on an HTTP GET request
on individual resource request or a collection of resources by query. If the
oslc.properties
query parameter is omitted on the request, then all resource properties MUST be
provided in the response.
[SML-33]
An OSLC SysML client MAY request that a subset of a resource's properties be updated by identifying those
properties to be modified using the oslc.properties
URL parameter on a HTTP PUT request.
[SML-34]
An OSLC SysML Server MAY support updating a subset of a resource's properties by using the [LDPPatch]
PATCH
method.
[SML-35]
For compatibility with [OSLCCore2], an SysML Server MAY also support partial update by identifying those
properties to be modified using the oslc.properties
URL parameter on a HTTP PUT request.
[SML-36]
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.
[SML-37]
OSLC SysML Resources 2.1 Defines the vocabulary terms and constraints for OSLC Change Management resources. These terms and constraints are specified according to [OSLCCore3].
SysML OSLC servers MAY choose to limit the types of SysML resources that can be accessed directly with a URL, or are accessible for resource preview or selection and creation dialogs. This allows servers to simplify the OSLC REST API to those SysML elements that are necessary for their particular purpose. SysML Servers MUST allow direct access to at least Element and Relationship. [SML-38]
OSLC SysML servers SHOULD support Resource Shapes as defined in [OSLCShapes]. [SML-39]
OSLC SysML Servers MUST provide a ServiceProvider Resource that can be retrieved at a implementation dependent URI. [SML-40]
OSLC SysML Servers MUST provide a ServiceProviderCatalog Resource that can be retrieved at a implementation dependent URI. [SML-41]
OSLC SysML Servers MUST provide an oslc:serviceProvider
property for their defined resources that
will be the URI to a ServiceProvider Resource. This does not prevent SysML Servers from providing multiple
servie provider properties with different values, if the service provider supports multiple OSLC domain
specifications, and the resource is applicable to multiple domains.
[SML-42]
OSLC SysML Servers MUST supply a value of http://open-services.net/ns/am#
for the property
oslc:domain
on either oslc:ServiceProvider
or
oslc:ServiceProviderCatalog
resources.
[SML-43]
OSLC SysML Servers MAY support CreationFactories as defined by [OSLCCore3]. [SML-44]
OSLC SysML Servers MAY discard properties it does not recognize and continue the POST operation without warning to the client. The returned resource will contain the accepted properties (and server generated properties like the dcterms:identifer) so clients will be able to confirm if required what was accepted. [SML-45]
If OSLC SysML Servers support the creation of resources from the OSLC defined
oslc_am:Resource
format, there MUST be at least one Creation Factory entry in the Services
definition, and its oslc:usage
property MUST be set to
http://open-services/ns/core#default
. The oslc:resourceType
MUST be set to
http://open-services.net/ns/am#Resource
.
[SML-46]
If OSLC SysML Servers support the creation of resources from a resource other than
oslc_am:Resource
, there MUST be a separate creation services definition whose
oslc:usage
property MUST NOT be set to http://open-services/ns/core#default
.
[SML-47]
OSLC SysML Servers SHOULD support the Query Capabilities as defined by [OSLCCore3] for both
oslc_am:Resource
and oslc_am:LinkType
resources.
[SML-48]
If the service provider supports query capability for oslc_am:Resource
resources, it MUST support
the following query parameters:
[SML-49]
oslc.where
oslc.searchTerms
OSLC SysML Servers SHOULD support query capability for oslc_am:LinkType
resources. If supported
then SysML Servers MUST support a simple GET without any query parameters that returns all link type
resources. SysML Servers SHOULD support the full OSLC query syntax.
[SML-50]
OSLC SysML Servers SHOULD support the selection of resources by delegated selection dialogs as defined by [OSLCCore3]. [SML-51]
OSLC SysML Servers MAY support the creation of resources by delegated creation dialogs as defined by [OSLCCore3]. [SML-52]
In oslc:Dialog
elements, the two optional child elements; oslc:hintWidth
and
oslc:hintHeight
specify the suggested size of the dialog or frame to render the HTML content in.
Expected size values are defined by CSS length units.
[SML-53]
Implementations of this specification need to satisfy the following conformance clauses.
Clause Number | Requirement |
---|---|
SML-1 | This specification is based on [OSLCCore3]. OSLC SysML 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. |
SML-2 | An OSLC SysML server MUST implement the domain vocabulary defined in OSLC SysML Version 2.1. Part 2: Vocabulary |
SML-3 | SysML Servers MUST use absolute URIs for all references to resources by properties |
SML-4 | SysML Servers MAY ignore unknown content and SysML clients MUST preserve unknown content. SysML Servers MAY discard such properties and continue the POST or PUT operation without warning to the client. |
SML-5 | SysML Servers MUST support resource operations via standard HTTP operations |
SML-6 | SysML Servers SHOULD support resource modifications with standard HTTP PUT and DELETE methods. SysML Servers MAY limit modifications |
SML-7 | SysML Servers supporting update and delete of resources MUST support the standard HTTP If-Match header in PUT and DELETE for concurrency protection of resources. |
SML-8 | SysML Servers MAY provide paging for resources but only when specifically requested by clients |
SML-9 | SysML Servers MAY support requests for a subset of a resource's properties via the oslc.properties URL parameter retrieval via HTTP GET |
SML-10 | SysML Servers MAY support partial update of resources via the oslc.properties URL parameter retrieval via HTTP PUT and or using [LDPPatch]. |
SML-11 | SysML Servers MAY provide a Service Provider Catalog, MUST provide a Service Provider resource, and MAY provide other forms of discovery described in [OSLCCore3]. |
SML-12 | SysML Servers MAY provide creation factories for resource formats that it supports. SysML Servers MAY support creation factories for OSLC SysML defined resources formatted as application/rdf+xml. SysML Servers MAY support creation factories for other formats, and indicate such creation factories with a non-default identifier in the oslc:usage property of the creation factory definition in the service provider document |
SML-13 | SysML Servers MUST provide query capabilities on oslc_am:Resource resources to enable clients to query for resources. SysML Servers SHOULD support a query interface for oslc_am:LinkType resources that support a GET for all LinkType resources. Such a GET does not require any simple query syntax parameters. SysML Servers MAY support the full query syntax for LinkType resources. |
SML-14 | OSLC query capabilities MUST support the OSLC Core Query Syntax |
SML-15 | SysML Services SHOULD offer selection delegated dialogs and MAY offer creation delegated dialogs specified via service provider resource |
SML-16 | SysML Services SHOULD offer resource previews for resources that may be referenced by other resources |
SML-17 | SysML Services SHOULD follow the recommendations for Authentication specified in [OSLCCore3] |
SML-18 | SysML Servers SHOULD provide error responses using OSLC Core defined error formats |
SML-19 | SysML Servers MUST support RDF/XML representations for OSLC Defined Resources |
SML-20 | SysML Servers MUST support XML representations that conform to the OSLC Core Guidelines for XML |
SML-21 | SysML Servers MAY support JSON representations; those which do MUST conform to the OSLC Core Guidelines for JSON |
SML-22 | SysML Servers MAY provide HTML representations for GET requests |
SML-23 |
SysML Servers MUST support RDF/XML representations with media-type application/rdf+xml . SysML
Clients SHOULD be prepared to deal with any valid RDF/XML document.
|
SML-24 |
SysML Servers MUST support XML representations with media-type application/xml . The XML
representations MUST follow the guidelines outlined in the
OSLC Core Representations Guidance
to maintain compatibility with [OSLCCore2].
|
SML-25 |
SysML Servers MAY support JSON representations with media-type application/json . The JSON
representations MUST follow the guidelines outlined in the
OSLC Core Representations Guidance
to maintain compatibility with [OSLCCore2].
|
SML-26 | For compatibility with OSLC 2.0, OSLC SysML Servers MAY accept the OSLC Core Version header (OSLC-Core-Version: 2.0) in any HTTP request as specified in [OSLCCore3], and return an OSLC SysML 2.0 representation (including the OSLC-Core-Version: 2.0 header). If the OSLC Core Version header is absent on a request, or has some undefined value, the OSLC SysML Server MUST return an SysML 2.0 representation. |
SML-27 |
OSLC SysML Servers MUST support HTTP GET requests on SysML Resources, with an Accept header of
application/rdf+xml , and return the RDF/XML representation of the resource.
|
SML-28 |
OSLC SysML Servers SHOULD support HTTP GET requests on SysML Resources, with an Accept header of an HTML type
( application/html , application/xhtml ), and return either an HTML/XHTML
representation of the resource or redirect the client to another URL that can (i.e. 302 Redirect).
|
SML-29 | OSLC SysML Servers SHOULD support HTTP GET requests for user interface (UI) preview of SysML Resources as defined by [OSLCPreview]. |
SML-30 | OSLC SysML Servers SHOULD support resource modifications on SysML Resources with standard HTTP PUT and DELETE methods. SysML Servers MAY limit modifications in any way they want. For example a service provider may limit updates to resources to simple link properties of link types already defined in the provider. Modification methods MUST use the If-Match header for concurrency management. Providers MAY discard such properties and continue a PUT operation without warning to the client. |
SML-31 | OSLC SysML Servers SHOULD support resource modifications on LinkType Resources (LTR) with standard HTTP PUT and DELETE methods. SysML Servers MAY limit modifications in any way they want. For example a service provider may not support additional properties. Modification methods SHOULD use the If-Match header for concurrency management. |
SML-32 | OSLC SysML Servers SHOULD support pagination of query results and MAY support pagination of a single resource's properties as defined by [OSLCCore3]. |
SML-33 |
An OSLC SysML server MAY support the oslc.properties URL query parameter on an HTTP GET request
on individual resource request or a collection of resources by query. If the
oslc.properties query parameter is omitted on the request, then all resource properties MUST be
provided in the response.
|
SML-34 |
An OSLC SysML client MAY request that a subset of a resource's properties be updated by identifying those
properties to be modified using the oslc.properties URL parameter on a HTTP PUT request.
|
SML-35 |
An OSLC SysML Server MAY support updating a subset of a resource's properties by using the [LDPPatch]
PATCH method.
|
SML-36 |
For compatibility with [OSLCCore2], an SysML Server MAY also support partial update by identifying those
properties to be modified using the oslc.properties URL parameter on a HTTP PUT request.
|
SML-37 |
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.
|
SML-38 | SysML OSLC servers MAY choose to limit the types of SysML resources that can be accessed directly with a URL, or are accessible for resource preview or selection and creation dialogs. This allows servers to simplify the OSLC REST API to those SysML elements that are necessary for their particular purpose. SysML Servers MUST allow direct access to at least Element and Relationship. |
SML-39 | OSLC SysML servers SHOULD support Resource Shapes as defined in [OSLCShapes]. |
SML-40 | OSLC SysML Servers MUST provide a ServiceProvider Resource that can be retrieved at a implementation dependent URI. |
SML-41 | OSLC SysML Servers MUST provide a ServiceProviderCatalog Resource that can be retrieved at a implementation dependent URI. |
SML-42 |
OSLC SysML Servers MUST provide an oslc:serviceProvider property for their defined resources that
will be the URI to a ServiceProvider Resource. This does not prevent SysML Servers from providing multiple
servie provider properties with different values, if the service provider supports multiple OSLC domain
specifications, and the resource is applicable to multiple domains.
|
SML-43 |
OSLC SysML Servers MUST supply a value of http://open-services.net/ns/am# for the property
oslc:domain on either oslc:ServiceProvider or
oslc:ServiceProviderCatalog resources.
|
SML-44 | OSLC SysML Servers MAY support CreationFactories as defined by [OSLCCore3]. |
SML-45 | OSLC SysML Servers MAY discard properties it does not recognize and continue the POST operation without warning to the client. The returned resource will contain the accepted properties (and server generated properties like the dcterms:identifer) so clients will be able to confirm if required what was accepted. |
SML-46 |
If OSLC SysML Servers support the creation of resources from the OSLC defined
oslc_am:Resource format, there MUST be at least one Creation Factory entry in the Services
definition, and its oslc:usage property MUST be set to
http://open-services/ns/core#default . The oslc:resourceType MUST be set to
http://open-services.net/ns/am#Resource .
|
SML-47 |
If OSLC SysML Servers support the creation of resources from a resource other than
oslc_am:Resource , there MUST be a separate creation services definition whose
oslc:usage property MUST NOT be set to http://open-services/ns/core#default .
|
SML-48 |
OSLC SysML Servers SHOULD support the Query Capabilities as defined by [OSLCCore3] for both
oslc_am:Resource and oslc_am:LinkType resources.
|
SML-49 |
If the service provider supports query capability for oslc_am:Resource resources, it MUST support
the following query parameters:
|
SML-50 |
OSLC SysML Servers SHOULD support query capability for oslc_am:LinkType resources. If supported
then SysML Servers MUST support a simple GET without any query parameters that returns all link type
resources. SysML Servers SHOULD support the full OSLC query syntax.
|
SML-51 | OSLC SysML Servers SHOULD support the selection of resources by delegated selection dialogs as defined by [OSLCCore3]. |
SML-52 | OSLC SysML Servers MAY support the creation of resources by delegated creation dialogs as defined by [OSLCCore3]. |
SML-53 |
In oslc:Dialog elements, the two optional child elements; oslc:hintWidth and
oslc:hintHeight specify the suggested size of the dialog or frame to render the HTML content in.
Expected size values are defined by CSS length units.
|
This section is non-normative.
The following individuals have participated in the creation of this specification and are gratefully acknowledged:
Participants:
James Amsden, IBM (Editor)
Jad El-khoury, KTH