Architecture Management Resource REST API

1.0 SPECIFICATION DRAFT

Introduction

In general a model in the architecture management space is stored across many resources. Each resource (i.e. element in a model) may have its own URI. This document specifies the behavior of the Service Provider when a client performs HTTP operations on the URI.

GET {AMR URI}

If the resource exists and the user has the priivledges to receive the resource, the return SHOULD be some representation of the entity represented by the URI. The exact format of the return contents depends on the Accept header and the ability of the service to provide the information in that form. Typically the return will be the OSLC Resource document, the actual raw contents of the resource, or a redirection to the web interface for rendering/viewing the resource. If more than one header is specified the service will decide which to format to return.

A service provider MUST support at least the following HTTP response status codes:

Service providers MAY support resource paging.

Service providers MAY support selective properties. Providers that do not support selective properties MUST respond with a 400 response and an appropriately worded error message.

Example

Request

GET https://liz:9443/resources/gcp_123

Response

<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF 
   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
   xmlns:dc="http://purl.org/dc/terms/">

    <rdf:Description rdf:about="https://liz:9443/resources/gcp_123">

        <dc:title>ServiceInterface</dc:title>
        <rdf:type rdf:resource="http://www.eclipse.org/uml2/3.0.0/UML#Interface"/>
        <dc:source rdf:resource="https://liz:9443/resources/gcp_123?source"/>
        <dc:description>
            Provides an service. This text may come from the model element's documentation properties.
        </dc:description>
        <dc:creator rdf:resource="https://liz:9443/users/adam"/>
        <dc:created rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime"> 2008-09-16T08:42:11.265Z</dc:created>
        <dc:contributor rdf:resource="https://liz:9443/users/dan"/>
        <dc:modified rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime"> 2008-12-16T10:12:00.000Z</dc:modified>
        <acme:accountCode>CUST123</acme:accountCode>
        <acme:elaborates rdf:resource="https://req.acme.com/reqs/req1"/>
        <dc:license rdf:resource="http://open-services.net/html/Terms.html"/>

    </rdf:Description>
</rdf:RDF> 

POST {AMR URI}

Not supported. The Service Provider MUST return a 405 Method Not Allowed response. The response MUST include an Allow header containing a list of valid methods for the requested resource.

PUT {AMR URI}

Update the referenced resource with the request's body. Depending on the Content Type header the Service Provider MAY support the update of the resource. If the Service Provider does not support the specified content type the Service Provider MUST return a 415 Unsupported Media Type response, and the response MUST include an Allow header containing a list of valid methods for the requested resource, given the specified Content Type. If the Service Provider supports the update of the model resource the request body contains the entire resource to be replaced.

The request MUST include the current ETag value for the resource.

A service provider MUST support at least the following HTTP response status codes:

Updating an AM resource involves replacing the current value with the entire supplied value.

DELETE {AMR URI}

Delete the AM resource represented by the given URL. Service providers MAY support a DELETE request on AM Resources. Further GET requests on this resource SHOULD result in a "410 Gone", a "404 Not Found" response or in the case of a ETag mismatch, 409 Conflict.

A service provider MUST support at least the following HTTP response status codes: