Querying Windchill artifacts using OSLC services

The capability to query Windchill artifacts using OSLC vocabulary is declared on the Service Provider representing the Windchill product or library.

Identify the URL of the query capability

To determine the URL of the OSLC query capability:

1. Request the Service Provider of the Windchill product or library.
2. Identify the <oslc:Service> XML element whose <oslc:domain> is http://open-services.net/ns/cm# or http://open-services.net/ns/am#.
3. Identify the nested <oslc:QueryCapability> XML elements whose <oslc:resourceType> is http://open-services.net/ns/cm#ChangeRequest or http://open-services.net/ns/am#Resource.
4. Identify the nested <oslc:queryBase> XML element that defines the base URL for the query capability. For Change Management domain, the URL of the queryBase element must contain the type of Change Artifacts (ChangeRequest, ChangeNotice or ProblemReport) as a query parameter.

<rdf:RDF 
  ...
  <oslc:ServiceProvider rdf:about="https://SERVER:PORT/Windchill/oslc-connect/cm/provider?serviceProvider=PRODUCT_ID">
    <oslc:service>
      <oslc:Service>
        <oslc:domain rdf:resource="http://open-services.net/ns/cm#"/>
        <oslc:queryCapability>
          <oslc:QueryCapability>
            <oslc:queryBase rdf:resource="https://SERVER:PORT/Windchill/oslc-connect/cm/query?serviceProvider=OR:wt.pdmlink.PDMLinkProduct:PRODUCT_ID;type=ChangeRequest"/>
            <oslc:resourceType rdf:resource="http://open-services.net/ns/cm#ChangeRequest"/>
            <oslc:resourceShape rdf:resource="https://SERVER:PORT/Windchill/oslc-connect/cm/resourceShape/WindchillChangeRequest/OR:wt.pdmlink.PDMLinkProduct:PRODUCT_ID"/>
          </oslc:QueryCapability>
        </oslc:queryCapability>
      </oslc:Service>
    </oslc:service>
  </rdf:Description>
</rdf:RDF>

Get the allowed values for an Enumerated attribute

Some attributes in Windchill are based on Enumerations. When used in a query, the value of the attribute must be a URL. The list of allowed values (i.e. the URLs) and their display title are available in the ResourceShape whose URL is given in the Query Capability.

• Method: GET
• URL: the resourceShape URL
• Request Headers:
  • Authorization: Windchill user and password encoded as BASIC authentication
  • Accept: application/xml
  • OSLC-Core-Version: 2.0
• Response Status: the HTTP response status
• Response Body: An XML stream describing the Resource Shape, which looks the following:

<rdf:RDF 
  ...
  <oslc:Property>
  	<oslc:propertyDefinition rdf:resource="http://namespaces.sodius.com/windchill/cm/1.0#issuePriority"/>
	<oslc:representation rdf:resource="http://open-services.net/ns/core#Reference"/>
	<oslc:allowedValue>
		<j.0:AllowedValue rdf:about="https://SERVER:PORT/Windchill/oslc-connect/cm/resourceShape/WindchillProblemReport/OR:wt.pdmlink.PDMLinkProduct:PRODUCT_ID#issuePriority.RU1FUkdFTkNZ">
			<dcterms:title rdf:datatype="http://www.w3.org/2001/XMLSchema#string">Emergency</dcterms:title>
		</j.0:AllowedValue>
	</oslc:allowedValue>
				
      ...
</rdf:RDF>

Execute the query capability

The query capability supports the syntax defined by the OSLC Query Specification. You should get familiar with this specification. The information provided below is a just a brief introduction of the general behavior of a query execution.

Refer to Mapping of Windchill attributes for OSLC Queries to understand which OSLC properties are supported and their corresponding Windchill attribute.

To execute an OSLC query:

• Method: GET
• URL: the query base URL with some OSLC query parameters (that need to be URI encoded)
• Request Headers:
  • Authorization: Windchill user and password encoded as BASIC authentication
  • Accept: application/xml
  • OSLC-Core-Version: 2.0
• Response Status: the HTTP response status
• Response Body: An XML stream describing the query results, which looks the following:

<rdf:RDF 
  ...
  <oslc:ResponseInfo>
    <oslc:totalCount rdf:datatype="http://www.w3.org/2001/XMLSchema#int">22</oslc:totalCount>>
  </oslc:ResponseInfo>
  <rdf:Description rdf:about="windchill-query-base-url">
    <rdfs:member>
      <oslc_cm:ChangeRequest rdf:about="windchill-artifact-url">
         ...
      </oslc_cm:ChangeRequest>
      ...
    </rdfs:member>
  </rdf:Description>
</rdf:RDF>

Query Parameters Support Matrix

Below is the table of OSLC query parameters defined by the specification and the level of support in the connector.

Examples of OSLC Queries

Below are typical queries you may execute: