Prev | Next |
oslc.select Parameter
The 'oslc.select' Query parameter specifies the properties of the Resources to be retrieved; it is similar to the SELECT clause of an SQL statement. This parameter must be appended to the base URI of the Query Capability in Enterprise Architect as:
<protocol>://<server>/<model_name>/oslc/am/qc/?oslc.select=<CSV of Resource Properties>
The syntax for the 'oslc.select' Query parameter (defined in BNF grammar and as specified in the OSLC Query Syntax Specification) is:
The Resource properties that can be selected are:
- dcterms:title
- dcterms:type
- dcterms:identifier
- dcterms:subject
- dcterms:creator / dcterms:creator{foaf:name} / dcterms:creator{*}
- dcterms:created
- dcterms:modified
- dcterms:description
- ss:status
- ss:complexity
- ss:stereotype / ss:stereotype{*}
- ss:phase
- ss:version
- ss:language
- ss:parentresourceidentifier
- ss:resourcetype
- ss:features
- ss:nestedresources
- ss:linkedresources
Examples
No. |
Query |
---|---|
1 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=* Selects all properties of all Resources in the model. |
2 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=dcterms:title Selects the name of every Resource in the model. |
3 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=dcterms:title,dcterms:type,dcterms:identifier Selects the name, type and GUID of every Resource in the model. |
4 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=dcterms:title,dcterms:creator{foaf:name},ss:version Alternative: http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=dcterms:title,dcterms:creator{*},ss:version Selects the name, author and version of every Resource in the model. |
5 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=name Returns an error response as 'name' is not a valid Resource property. |
Notes
- This facility is available through the Pro Cloud Server, with a valid license
- In a security-enabled model, you need to provide the User Authentication Token (via the 'useridentifier' query string in the URL) in the GET request to retrieve the Resource/Resource Feature XML
Learn more
- oslc.select (Online Resource)
- User Authentication Token