This wiki is locked. Future workgroup activity and specification development must take place at our new wiki. For more information, see this blog post about the new governance model and this post about changes to the website.

OSLC Core Common Properties DRAFT

By: The OSLC Core Specification Workgroup

This is a DRAFT document that is under review. You can help by reviewing carefully, raising issues for discussion on the OSLC Core WG mailing list.

Purpose

The purpose of this document is to record common properties for use across OSLC specifications, but not to require them. OSLC resources are not required to include these properties. OSLC workgroups should consult this list of properties before defining each new property and if a suitable common property exists, then the workgroup should use that common property rather than defining a new one.

Dublin Core Properties

These are the Dublin Core Metadata Element Set properties that are considered common (reference: Dublin Core).

  • Namespace URI: http://purl.org/dc/terms
  • Suggested Prefix: dcterms

Prefixed Name Type Typically Occurs Title Description
dcterms:identifier String exactly-one Identifier 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 -- it is often accompanied by a dc:name property.
dcterms:name XMLLiteral zero-or-one Name Short name identifying a resource, often used as an abbreviated identifier for presentation to end-users. SHOULD include only content that is valid inside an XHTML <span> element.
dcterms:subject String zero-or-many Subject Tag or keyword for a resource. Each occurrence of a dc:subject property denotes an additional tag for the resource.
dcterms:creator Resource or Local Inline Resource of type foaf:Person zero-or-many Creator Creator or creators of resource (reference: Dublin Core)
dcterms:created Date Time zero-or-one Created Timestamp of resource creation (reference: Dublin Core)
dcterms:modified Date Time zero-or-one Modified Timestamp last latest resource modification (reference: Dublin Core)

OSLC Properties

These are the OSLC defined properties that are considered common.

  • Namespace URI: http://open-services.net/xmlns/oslc#
  • Suggested Prefix: oslc

Prefixed Name Type Typically Occurs Title Description
oslc:discussion Resource of type Discussion zero-or-one Discussion A sequence of notes and discussions.

Common Resource definitions

The OSLC Core specification may define common resource definitions, available for use in OSLC domain specifications as value-types.

oslc:Comment

A Comment resource represents a single note, or comment, in a discussion thread.

  • Name: Comment
  • URI: http://open-services.net/xmlns/oslc#Comment
  • Description: Data necessary to represent a comment
  • Properties:
    • dc:identifier (String, exactly-one) A service defined identifier
    • dc:creator (Resource of type foaf:Person, exactly-one) The person who created the comment
    • dc:title (XMLLiteral xhtml, zero-or-one) A brief title for the comment
    • dc:created (!DateTime, exactly-one) When the comment resource was created
    • dc:description (XMLLiteral xhtml, exactly-one) Details or body of the comment
    • oslc:discussion (Resource of type oslc:Discussion, exactly-one) reference to owning Discussion resource
    • oslc:inReplyTo (Resource of type oslc:Comment, zero-or-one) reference to comment this comment is in reply to

oslc:Discussion

A Discussion resource is intended to represent a sequence of comments or notes regarding the associated resource.

  • Name: Discussion
  • URI: http://open-services.net/xmlns/oslc#Discussion
  • Description: Contains a series of comment properties
  • Properties of Comments resource shape:
    • oslc:discussionAbout (Resource, exactly-one) reference to associated resource
    • oslc:comment (Resource oslc:Comment, zero-or-more)

Comment Creation

POST {Discussion URI}

Posting a well formed Comment Resources results in the creation of a comment resource. A service provider MUST support at least the following HTTP response status codes:

Status Code Response Content Description
201 Created HTTP-Header : Location: {New Comment URI A new comment resource has been created at the URI returned
400 Bad Request Error message Malformed content (comment resource format is invalid)
404 Not Found Error message The request URL does not represent a URL on the server
409 Conflict Error message Possible reasons: setting inReplyTo not supported, referenced comment URI invalid, etc.
Edit | Attach | Print version | History: r5 < r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r4 - 14 Jul 2010 - 14:15:07 - DaveJohnson
 
This site is powered by the TWiki collaboration platform Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding this site? Send feedback