API Demonstration

This page demonstrates how to use the QSC API to get the list of known issues in a build

Contents

Getting Access to the API

Refer to Get access to the API for how to generate and use an API key to invoke the API.

Getting the known issues (CRs) for a software product release

Getting the list of known issues is an asynchronous process which consists of:

  1. Submit request for known issues for a given software product and release tag
  2. Check on the status of the request until it goes to the 'Complete' state (polling)
  3. Get the results (list of CRs)

1. Submit Known Issues Request

API used to submit a Known Issues CRs request for a Software Product and Release Tag

POST https://api.qualcomm.com/softwarecenter/v1/chipSoftware/knownIssues

Sample Request Body

{
  "softwareProductName": "Sariska.MN.1.0",
  "releaseTag": "r00024.1"
}

Sample Response

{
  "id": "dedcc262-6c29-44a3-96c0-0f660a0e2a84",
  "softwareProduct": "Sariska.MN.1.0",
  "releaseTag": "r00024.1",
  "requestedDate": "2025-09-22T16:34:35.303225",
  "requester": "username@example-company.com",
  "status": "InProgress"
}
  • The possible values for 'status' are: 'InProgress', 'Complete', 'Failed'

Differences from Planner APIs on Qualcomm® CreatePoint

  1. In Request Body:
    1. 'swProduct' is changed to 'softwareProductName'
    2. 'buildTag' is changed to 'releaseTag'
    3. 'branch' is no longer used to get results
  2. In response:
    1. The following fields are removed
      • 'partyId'
      • 'numOfCrsUpdated'
      • 'propCrRequired'
      • 'retryCount'
      • 'referenceCr'
      • 'releaseId'
      • 'plannerUrl'
      • 'branch'
      • 'nextAttemptDate'
      • 'indexDate'
    2. 'id' is changed from int to UUID String
    3. 'status' field is changed to be of type String. The possible values are now: 'InProgress', 'Complete','Failed'
    4. Field Name Changes:
      • 'dateCreated' -> 'requestedDate'
      • 'buildTag' -> 'releaseTag'
      • 'createdBy' -> 'requester'
      • 'refreshDate' -> 'completedDate'
    5. Null values are hidden from response. Below are the possible fields:
    {
      "id": "string",
      "softwareProduct": "string",
      "releaseTag": "string",
      "requestedDate": "string",
      "requester": "string",
      "status": "string",
      "completedDate": "string"
    }

2. Get Status of Known Issues CR Request

API used to get the status of a submitted known issues CR Request for a Software Product and Release Tag

GET https://api.qualcomm.com/softwarecenter/v1/chipSoftware/knownIssues/{softwareProductName}/{releaseTag}/status

Sample Request

GET https://api.qualcomm.com/softwarecenter/v1/chipSoftware/knownIssues/Sariska.MN.1.0/r00024.1/status

Sample Response

{
  "latestCompletedKnownIssuesRequest": {
    "id": "bb247344-de95-4b82-9103-2b8e8fdf4951",
    "softwareProduct": "Sariska.MN.1.0",
    "releaseTag": "r00024.1",
    "requestedDate": "2025-09-18T17:53:43.433765",
    "completedDate": "2025-09-18T17:54:26.785241",
    "requester": "username@example-company.com",
    "status": "Complete"
  },
  "latestKnownIssuesRequest": {
    "id": "a45d2edd-0fca-462d-98cf-5181dc4ce3fa",
    "softwareProduct": "Sariska.MN.1.0",
    "releaseTag": "r00024.1",
    "requestedDate": "2025-09-18T17:58:47.64294",
    "requester": "username@example-company.com",
    "status": "InProgress"
  }
}

Differences from Planner APIs on Qualcomm® CreatePoint

  1. In Request
    1. 'branch' is no longer used to get results
  2. In Response
    1. The response now returns the latest completed known issues request and the latest known issues request from a user
    2. The following fields are removed
      • 'partyId'
      • 'numOfCrsUpdated'
      • 'propCrRequired'
      • 'retryCount'
      • 'referenceCr'
      • 'releaseId'
      • 'plannerUrl'
      • 'branch'
      • 'nextAttemptDate'
      • indexDate
    3. 'id' is change from int to UUID String
    4. 'status' field is changed to be of type String. The possible values are now: 'InProgress', 'Complete','Failed'
    5. Field Name Changes:
      • 'dateCreated' -> 'requestedDate'
      • 'buildTag' -> 'releaseTag'
      • 'createdBy' -> 'requester'
      • 'refreshDate' -> 'completedDate'
  3. Null values are hidden from response. Below are the possible fields:
    {
      "latestCompletedKnownIssuesRequest": {
        "id": "string",
        "softwareProduct": "string",
        "releaseTag": "string",
        "requestedDate": "string",
        "completedDate": "string",
        "requester": "string",
        "status": "string"
      },
      "latestKnownIssuesRequest": {
        "id": "string",
        "softwareProduct": "string",
        "releaseTag": "string",
        "requestedDate": "string",
        "completedDate": "string",
        "requester": "string",
        "status": "string"
      }
    }

3. Get Known Issues CR Results

API to retrieve the paginated results of known issues CRs for the most recent completed request of a given SP and Release Tag.

GET https://api.qualcomm.com/softwarecenter/v1/chipSoftware/knownIssues/{softwareProductName}/{releaseTag}?pageSize={pageSize}&pageNumber={pageNumber}&sort={sortField,order}&fixStatus={fixStatus}

Query parameters:

  • pageSize: Number of records per page (default 500, max 1000)
  • pageNumber: 0 indexed page number (default 0)
  • sort: Sort the results by the given field and order (default: crNumber,asc) (other supported sort fields: fixStatus, softwareImage)
  • fixStatus: filter the results by the given fix status (default: no filtering by fixStatus)

Sample Request

GET https://api.qualcomm.com/softwarecenter/v1/chipSoftware/knownIssues/Sariska.MN.1.0/r00024.1?pageSize=500&pageNumber=0&fixStatus=Complete

Sample Response

{
    "pageNumber": 0,
    "pageSize": 500,
    "total": 84,
    "results": [
        {
            "certificationImpacts": "none",
            "changeDescription": "VSWR init coupler failure fix",
            "sideEffects": "none",
            "changeVerification": "basic sanity is done",
            "crNumber": "3330112",
            "failureFrequency": "Occasionally",
            "fixStatus": "Complete",
            "functionalArea": "RFA_UMTS",
            "imageBuildId": "MPSS.DE.7.0.c4-00236-SARISKA_MNRMTEFS_PACK-1",
            "impactCategory": "Stability",
            "oemBranchSpecific": false,
            "relatedCRs": "3330086, 3330112, 3311953, 3311953, 3330185, 3333742, 3330112, 3330112",
            "problemDescription": "Crash due to concurrency between vswr...",
            "problemScenario": "Run WCDMA call and Trigger ASDIV ",
            "regression": "False",
            "riskAssessment": "Low",
            "scenarioLikelihood": "Uncommon",
            "softwareImage": "MPSS.DE.7.0.c4",
            "subSystem": "RFA",
            "title": "VSWR init coupler failure fix"
        },
        {
            "certificationImpacts": "none",
            "changeDescription": "VSWR init coupler failure fix",
            "sideEffects": "none",
            "changeVerification": "basic sanity done",
            "crNumber": "3330185",
            "failureFrequency": "Occasionally",
            "fixStatus": "Complete",
            "functionalArea": "RFA_UMTS",
            "imageBuildId": "MPSS.DE.7.0.c4-00236-SARISKA_MNRMTEFS_PACK-1",
            "impactCategory": "Stability",
            "oemBranchSpecific": false,
            "relatedCRs": "3330185, 3330112",
            "problemDescription": "Crash due to concurrency between vswr...",
            "problemScenario": "Run WCDMA call and Trigger ASDIV",
            "regression": "False",
            "riskAssessment": "Low",
            "scenarioLikelihood": "Unknown",
            "softwareImage": "MPSS.DE.7.0.c4",
            "subSystem": "RFA",
            "title": "VSWR init coupler failure fix"
        }...
    ]
}
  • Null values will be hidden. Below are the possible fields for each CR and their types:
{
  "affectedFiles": "string",
  "blockingSeverity": "string",
  "category": "string",
  "certificationImpacts": "string",
  "changeDescription": "string",
  "changeVerification": "string",
  "commitId": "string",
  "crNumber": "string",
  "cve": "string",
  "failureFrequency": "string",
  "fixStatus": "string",
  "functionalArea": "string",
  "gapSecurityBulletinMonth": "string",
  "imageBuildId": "string",
  "impactCategory": "string",
  "isCrash": "string",
  "isExternallyReported": "string",
  "oemBranchSpecific": "boolean",
  "oemSecurityBulletinMonth": "string",
  "probableFixAvailabilityDate": "string",
  "problemDescription": "string",
  "problemOccurrence": "string",
  "problemRecovery": "string",
  "problemScenario": "string",
  "regression": "string",
  "relatedCRs": "string",
  "riskAssessment": "string",
  "scenarioLikelihood": "string",
  "securityAccessVector": "string",
  "securityCWE": "string",
  "securityRating": "string",
  "securityVulnerability": "string",
  "sideEffects": "string",
  "softwareImage": "string",
  "subSystem": "string",
  "tags": "string",
  "title": "string",
  "vcsProject": "string"
}

Differences from Planner APIs on Qualcomm® CreatePoint

  1. In Request
    1. Request becomes a GET request
    2. 'pageSize' (Max: 1000, Default: 500) and 'pageNumber' (Starts from 0) query parameters added. The 'total' integer value can be used to determine if there are remaining pages.
    3. Sorting by crNumber, fixStatus, softwareImage is supported. Optionally, use comma followed by asc or desc to control order. Default if not provided is crNumber ascending. Example to sort by fixStatus ascending then crNumber descending: sort=fixStatus&sort=crNumber,desc
    4. 'branch' is no longer used to get results
  2. In Results:
    1. Response is paginated
    2. Fields that are not returned:
      • 'buildTag'
      • 'branch'
      • 'releasePublishedDate'
      • 'radarNumbers'
      • 'type'
      • 'softwareProduct'
    3. Changed field names:
      • 'changeSideEffects' -> 'sideEffects'
      • 'securityPublicIds' -> 'cve'
      • 'filesAffected' -> 'affectedFiles'
      • 'imageBuildNumber' -> 'imageBuildId'
      • 'isOemBranchSpecific' -> 'oemBranchSpecific'
      • 'prismRelatedCrs' -> 'relatedCRs'
      • 'probableFixAvailDateTime' -> 'probableFixAvailabilityDate'
      • 'securityCommonWeakness' -> 'securityCWE'
      • 'tagNames' -> 'tags'
    4. New fields:
      • 'blockingSeverity'
      • 'commitId'
      • 'isCrash'
      • 'isExternallyReported'
      • 'problemRecovery'
      • 'securityAccessVector'
      • 'vcsProject'
      • 'oemSecurityBulletinMonth'
      • 'gapSecurityBulletinMonth'