Pré. | Proc. |
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 |
See also |
---|---|---|
1 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=* & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} Selects all properties of all Resources in the model. |
|
2 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=dcterms:title & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} 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 & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} 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 & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} Alternative: http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=dcterms:title,dcterms:creator{*},ss:version & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} Selects the name, author and version of every Resource in the model. |
|
5 |
http://localhost:480/firebird_model/oslc/am/qc/?oslc.select=name & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7} 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
- GET request to retrieve the Resource/Resource Feature XML will not be processed by the Pro Cloud Server unless the User Authentication Token is passed in with the request (via the 'useridentifier' query string in the URL)
Learn more
- oslc.select (Online Resource)
- User Credentials for accessing OSLC RESTful API