Discovering Windchill RV&S Resources Using Reverse Lookup
The Windchill RV&S supports the discovery of the reverse lookup service query URL via the link header in the response of the catalog service.
To discover the reverse lookup service that returns resources for supported domains, you must read the link header of the root catalog URL.
The GET request: GET https://localhost:3001/oslc/r/catalog
The response header:
Link: <https://localhost:3000/oslc/r/reverselookup/resources>; rel="reverselookup"
The Windchill RV&S OSLC Server supports the wrvs:serviceProvider query capability included in the wrvs namespace for providing information about external OSLC links associated with the OSLC resources of Windchill Modeler. The wrvs:serviceProvider query capability is available for the reverse lookup web service only.
The Windchill RV&S OSLC Server supports the following URI with supported authentication for the discovery of the reverse lookup service:
GET <protocol scheme>://<server host name>:<server port number>/<context URI>/reverselookup
For example:
GET https://localhost:3001/oslc/r/reverselookup
The client applications must send such a GET request with the Accept header set to application/ld+json or application/rdf+xml and the oslc-core-version header set to 3.0.
The Windchill RV&S OSLC Server provides two query bases for the reverse lookup query in the response of such a GET request. The server supports the following two URIs for the query base of the reverse lookup query (one for fetching the reverse lookup for the requirements domain and one for fetching the reverse lookup for the change domain):
POST <protocol scheme>://<server host name>:<server port number>/<context URI>/reverselookup/<domain>/resources
For example:
• POST https://localhost:3001/oslc/r/reverselookup/rm/resources
• POST https://localhost:3001/oslc/r/reverselookup/cm/resources
The client applications must send the POST request with the Accept header set to application/ld+json or application/rdf+xml and the oslc-core-version header set to 3.0. The client applications must also specify the required query parameters in the body of such a POST request with the URI of the Windchill Modeler models or requirements.
The following query parameters are supported in the body of the POST request:
• oslc.where
• oslc.select
• oslc.pageSize
• $skiptoken
You can specify multiple comma-separated query parameters in the body of the POST request.
For example:
"oslc.where":"wrvs:externalUrl=https://myserver.atg.local:12345/oslc/2.0/servers/modeler/repositories/Examples/models/Active%20Deferred%20Ball%20Game%20Example/modelversions/0/am/architecture/750147e3-772d-4235-9c26-adc0180dc75b","oslc.select":"dcterms:identifier"
 |
• The oslc.orderBy query parameter is not supported in the POST request.
• The oslc:nextPage property containing the link to the next page of a query response is not supported in the POST request.
|
The format of response for such POST requests is similar to the format of response obtained for a query capability. In response to such POST requests for reverse lookup, the Windchill RV&S OSLC Server provides information of the Windchill RV&S resources that are associated or linked with the specified models or requirements of Windchill Modeler. The response also includes the URI of the Windchill RV&S resources under the wrvs:infoPage field for opening the items in the Refreshed Item View.
|
|
The Windchill RV&S OSLC Server provides information for the supported Windchill RV&S OSLC resource types (based on supported domain), such as requirements, requirement documents, defects, tasks, and so on, in the response for the reverse lookup query.
|