クエリ

クライアントはモデルに対してクエリ(問い合わせ)を行い、特定の条件に合致するリソースを取得できます。Enterprise Architectでは、クエリ機能にアクセスするための基本URIは以下の通りです。

<protocol>://<server>/<model_name>/oslc/am/qc/

特定の条件を表すクエリ文字列をベース URI に追加し、HTTP GET リクエストを使用してモデル宛に送信する必要があります。URIが長くなりすぎる場合(例えば1000文字を超える場合)、HTTP POSTリクエストを使用し、POSTの本体にクエリ文字列を記述することが推奨されます。このリクエストに対する応答は、RDF/XML形式になります。現在、Enterprise Architectでは、パッケージ・要素・ダイアグラムのプロパティのみ問い合わせることができます。属性・操作・シナリオなどの機能については問い合わせることができません。

Enterprise Architectでは、条件を指定するために、以下のQuery Capabilityパラメータをサポートしています。

oslc.where - リソースが満たすべき条件を指定します。SQL文のWHERE句に類似しています。
oslc.select - 取得するリソースのプロパティを指定します。SQL文のSELECT句に類似しています。

これらのパラメータを個別に、または組み合わせて使用することで、リソースを取得するための条件を指定することができます。

応答のXMLの構成要素

項目	説明
oslc_am:Resource	OSLC Architecture Management 2.0 Resourceとそのプロパティ（Resource Shapeで定義されているもの）を表します。この要素の 'rdf:about' 属性は、リソースにアクセスするための URL を指定します。このURLのフォーマットは以下の通りです。 <protocol>://<server>/<model_name>/oslc/am/resource/<Resource GUID With Prefix>/
Elements with namespace prefix 'dcterms'	Dublin Core Metadata Element Set の標準プロパティです。
Elements with namespace prefix 'foaf'	Friend of a Friend (FOAF) Vocabulary の標準プロパティです。
Elements with namespace prefix 'ss'	Enterprise Architectのカスタムプロパティです。

例

種類がアクターのすべての要素を取得します。

URL : http://localhost:480/firebird_model/oslc/am/qc/?oslc.where=dcterms:type="Actor" & useridentifier={72825AF9-E116-48f1-9DF8-77815E66B1A7}

応答の例は以下の通りです。

<rdf:RDF>

<rdf:Description rdf:about="http://mybuildvm:2480/firebird_model/oslc/am/qc/">

<rdfs:member>

<oslc_am:Resource rdf:about="http://localhost:480/firebird_model/oslc/am/resource/el_{9EAD1087-BC1A-4b04-804F-748713D10E42}/">

<rdf:type rdf:resource="http://open-services.net/ns/am#Resource"/>

<dcterms:title>A1</dcterms:title>

<dcterms:type>Actor</dcterms:type>

<dcterms:identifier>el_{9EAD1087-BC1A-4b04-804F-748713D10E42}</dcterms:identifier>

<dcterms:creator>

<foaf:Person>

<foaf:name>Sparx</foaf:name>

</foaf:Person>

</dcterms:creator>

<dcterms:created>2020-06-21 09:40:58</dcterms:created>

<dcterms:modified>2020-07-12 15:43:28</dcterms:modified>

<ss:status>Proposed</ss:status>

<ss:complexity>Easy</ss:complexity>

<ss:phase>1.0</ss:phase>

<ss:version>1.0</ss:version>

<ss:resourcetype>Element</ss:resourcetype>

<ss:parentresourceidentifier>pk_{56DF19B4-7035-40d2-9030-21D3383562A6}</ss:parentresourceidentifier>

<ss:features rdf:resource="http://localhost:480/firebird_model/oslc/am/features/el_{9EAD1087-BC1A-4b04-804F-748713D10E42}/"/>

<ss:nestedresources rdf:resource="http://localhost:480/firebird_model/oslc/am/nestedresources/el_{9EAD1087-BC1A-4b04-804F-748713D10E42}/"/>

</oslc_am:Resource>

</rdfs:member>

</rdf:Description>

</rdf:RDF>

注意:

OSLCの機能は有料ライセンスが適用されたProクラウドサーバのみで利用できます。

リソースやリソースフィーチャーの取得は、ユーザー認証トークンを渡すことが必要です。渡されない場合には処理は行いません。

参照:

OSLC RESTful APIを利用するためのユーザー認証