v1

latestOpenAPI 3.0.12026-08-06151265417.9 KB
Dependencies Source Files

Get source files inventory at application level

Returns a list of libraries together with the location of their source files. Supports filtering by library UUID using the search parameter. Example: ?search=libraryUuid==b366b0ef-b211-4c37-a47c-0077e4de709f

get/api/v3.0/applications/{applicationUuid}/dependencies/sourceFiles/inventory

Path parameters

applicationUuidstring required

Application UUID (Administration > Applications)

Query parameters

limitstring

Specifies the maximum number of items to be returned in the response.

cursorstring

Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.

Response

OK

additionalDataobject
  • totalItems: The total count of data points returned in an API response.
supportTokenstring

Example response

{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426655440000",
      "name": "common.js",
      "matchType": "MANUAL",
      "sha1": "e9537a5384f5a7569997e87fe639961e31b38887",
      "localPath": "C:\\Users\\",
      "library": {
        "uuid": "123e4567-e89b-12d3-a456-426655440000",
        "name": " actionview-v0.0.1",
        "licenses": [
          {
            "uuid": "123e4567-e89b-12d3-a456-426655440000",
            "name": "MIT",
            "spdxName": "Glide",
            "type": "OPEN_SOURCE",
            "profile": {
              "links": [
                "http://www.opensource.org/licenses/AFL-3.0"
              ],
              "copyrightRiskScore": {
                "explanation": "http://en.wikipedia.org/wiki/Academic_Free_License",
                "indicatingText": "1) Grant of Copyright License...",
                "riskScore": 39
              },
              "patentAndRoyaltyRisk": {
                "explanation": "http://en.wikipedia.org/wiki/Academic_Free_License",
                "indicatingText": "1) Grant of Copyright License...",
                "riskScore": 39
              },
              "royaltyFree": "Conditional",
              "copyleft": {
                "explanation": "http://en.wikipedia.org/wiki/Academic_Free_License",
                "indicatingText": "1) Grant of Copyright License...",
                "description": "Not a CopyLeft license.",
                "displayText": "No"
              },
              "linking": {
                "explanation": "http://en.wikipedia.org/wiki/Academic_Free_License",
                "indicatingText": "1) Grant of Copyright License...",
                "description": "Not a CopyLeft license.",
                "displayText": "No"
              },
              "requiredNotices": [
                "Must identify specific modifications"
              ]
            }
          }
        ]
      },
      "contextType": "Organization",
      "project": {
        "uuid": "123e4567-e89b-12d3-a456-426655440000",
        "name": "My Project",
        "path": "My Application",
        "applicationName": "My Application",
        "applicationUuid": "123e4567-e89b-12d3-a456-426655440000"
      }
    }
  ]
}