Querying Jira issues using OSLC services

The capability to query Jira issues using OSLC vocabulary is declared on the Service Provider representing the Jira project.

Identify the URL of the query capability

To determine the URL of the OSLC query capability:

1. Request the Service Provider of the Jira project of interest.
2. Identify the <oslc:Service> XML element whose <oslc:domain> is http://open-services.net/ns/cm# for Change Management or http://open-services.net/ns/qm# for Quality Management.
3. Identify the nested <oslc:QueryCapability> XML element whose <oslc:resourceType> is the required one.

   Domain	Resource Type	Resource Type URL
   Change Management	Change Request	http://open-services.net/ns/cm#ChangeRequest
   Quality Management	Test Case	http://open-services.net/ns/qm#TestCase
   	Test Plan	http://open-services.net/ns/qm#TestPlan
   	Test Execution Record	http://open-services.net/ns/qm#TestExecutionRecord
   	Test Result	http://open-services.net/ns/qm#TestResult
   	Test Script	http://open-services.net/ns/qm#TestScript

4. Identify the nested <oslc:queryBase> XML element that defines the base URL for the query capability.

<rdf:RDF 
  ...
  <oslc:ServiceProvider rdf:about="https://SERVER:PORT/rest/oslc/1.0/cm/project/PROJECT-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/rest/oslc/1.0/cm/issue/query/PROJECT-ID"/>
            <oslc:resourceType rdf:resource="http://open-services.net/ns/cm#ChangeRequest"/>
          </oslc:QueryCapability>
        </oslc:queryCapability>
      </oslc:Service>
    </oslc:service>
  </rdf:Description>
</rdf:RDF>

<rdf:RDF 
  ...
  <oslc:ServiceProvider rdf:about="https://SERVER:PORT/rest/oslc/1.0/qm/project/PROJECT-ID">
    ...
    <oslc:service>
      <oslc:Service>
        <oslc:domain rdf:resource="http://open-services.net/ns/qm#"/>
        <oslc:queryCapability>
          <oslc:QueryCapability>
            <oslc:queryBase rdf:resource="https://SERVER:PORT/rest/oslc/1.0/qm/TestCase/query/PROJECT-ID"/>
            <oslc:resourceType rdf:resource="http://open-services.net/ns/qm#TestCase"/>
          </oslc:QueryCapability>
        </oslc:queryCapability>
        ...
      </oslc:Service>
    </oslc:service>
  </rdf:Description>
</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 Jira fields for OSLC Queries to understand which OSLC properties are supported and their corresponding Jira field.

To execute an OSLC query:

• Method: GET (or POST if you want to use large query parameters as POST payload)
• URL: the query base URL with some OSLC query parameters (that need to be URI encoded)
• Request Headers:
  • Authorization: Jira user and password encoded as BASIC authentication
  • Accept: application/xml
  • Content-Type: application/x-www-form-urlencoded (only if a POST is used)
  • 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="jira-query-base-url">
    <rdfs:member>
      <oslc_cm:ChangeRequest rdf:about="jira-isue-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: