Skip to content

Get Project Inventory

Request

Returns a list of inventory and inventory details for a given project; includes a flag for a short/long version. All project users including Observer, Reviewer and Analyst can view project inventory of private projects.

Security
bearerAuth
Path
projectIdinteger, (int64)required

ID of the Project

Example:1
Query
skipVulnerabilitiesboolean

If true , hide vulnerability details in the response

Default:false
publishedboolean

If true, then only published inventory items are returned; if false, then only not-published inventory items are returned;; if all, then all inventory items are returned

Default:true
vendorstring

CPE Vendor name (Example: gnu)

productstring

CPE Product name (Example: zlib)

sizeinteger, (int64)

Page Size. Number Of Records to fetch per page

Default:100
pageinteger, (int64)

Page Number. Index of the page to start with(starts from 1)

Default:1
reviewStatusstring

return items based on the reviewStatus which we selected. Ex: if reviewStatus is APPROVED then only APPROVED items returned

Enum:"READY_TO_REVIEW""DRAFT""APPROVED""REJECTED"
alertsstring

return items based the alert status selected. If alert status selected as OPEN then only open alerts returned

Enum:"OPEN""CLOSED""ANY"
includeFilesboolean

If true, display the associated files to an Inventory(Default is true)

Default:true
includeCopyrightsboolean

If true, display the copyrights of an Inventory(Default is false)

Default:false
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/project/inventory/1?skipVulnerabilities=false&published=true&vendor=string&product=string&size=100&page=1&reviewStatus=READY_TO_REVIEW&alerts=OPEN&includeFiles=true&includeCopyrights=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
licenseDetectionMethodstring, (byte)
vulnerabilityAlertsArray of objects, unique(InventoryAlert)
autoDetectionNotesstring

detection notes

Example:"Note"
associatedLicenseobject(License)

License

Example:1
rejectedByUpdateboolean
userUpdatedStatusstring
descriptionstring

Description

Example:"Description"
namestring

Inventory group name

Example:"git"
priorityobject(PicklistValue)
idinteger, (int32)

Inventory group id

Example:1
ownerstring

Owner

Example:"antlr"
urlstring

Url

Example:"http://www.antlr.org"
statusstring
Enum:"UNUSED0""UNUSED1""UNUSED2""UNUSED3""DRAFT""READY_TO_REVIEW""APPROVED""REJECTED"
publishedDatestring, (date-time)

publishedOn

parentGroupIdinteger, (int32)
systemGeneratedboolean

System generated

Example:true
autoStatusstring
Enum:"DRAFT""PUBLISHED""NEEDS_REVIEW"
statusPolicyIdinteger, (int32)
priorityIdinteger, (int32)
usageTextstring

get usage text

Example:"usage"
projectIdinteger, (int32)

Project Id

Example:1
publishedboolean

is published

Example:true
inventoryTypestring
Enum:"Work in Progress""Component""Material from Website""Material from Publication""License Only"
modifiedstring

modified

Enum:"No""Yes""Unknown"
Example:"Unknown"
linkingstring

link type

Enum:"Unknown""Not Linked""Statically Linked""Dynamically Linked"
Example:"Unknown"
eccnstring
partOfProductstring

part of product

Enum:"No""Yes""Unknown"
Example:"Unknown"
distributedstring

distribution type

Enum:"Unknown""Internal""External""Hosted-Any""Hosted for Internal Use""Hosted for External Use"
Example:"Unknown"
confidencestring

Confidence

Enum:"HIGHEST""HIGH""MEDIUM""LOW"
Example:"1"
disclosedboolean

is Disclosed

Example:true
encryptedstring

encryption

Enum:"No""Yes""Unknown"
Example:"Unknown"
noticeTextstring

Notices text

Example:"Notice text"
copyrightTextstring
repositoryItemobject(RepositoryItem)
provenanceIdinteger, (int32)
createDatestring, (date-time)

Create on

updateDatestring, (date-time)

updatedOn

fileCountinteger, (int32)

File count

Example:2000
dependencyScopestring
licenseobject(License)

License

Example:1
auditorReviewNotesstring

audit notes

Example:"good to go"
remediationNotesstring

Remediation notes

Example:"update this immediately"
workflowURLstring
associatedComponentobject(Component)
associatedComponentVersionobject(ComponentVersion)
closedVulnerabilityAlertsArray of objects, unique(InventoryAlert)
openVulnerabilityAlertsArray of objects, unique(InventoryAlert)
asFoundLicenseTextstring

As found license text

Example:"Sample from file LICENSE.txt in file ePortal-2.0"
Response
{
  "licenseDetectionMethod": "string",
  "vulnerabilityAlerts": [
    { … }
  ],
  "autoDetectionNotes": "Note",
  "associatedLicense": 1,
  "rejectedByUpdate": true,
  "userUpdatedStatus": "string",
  "description": "Description",
  "name": "git",
  "priority": {
    "id": 0,
    "type": "INVENTORY_STATUS",
    "name": "string",
    "description": "string",
    "isDefault": true
  },
  "id": 1,
  "owner": "antlr",
  "url": "http://www.antlr.org",
  "status": "UNUSED0",
  "publishedDate": "2019-08-24T14:15:22Z",
  "parentGroupId": 0,
  "systemGenerated": true,
  "autoStatus": "DRAFT",
  "statusPolicyId": 0,
  "priorityId": 0,
  "usageText": "usage",
  "projectId": 1,
  "published": true,
  "inventoryType": "Work in Progress",
  "modified": "Unknown",
  "linking": "Unknown",
  "eccn": "string",
  "partOfProduct": "Unknown",
  "distributed": "Unknown",
  "confidence": "1",
  "disclosed": true,
  "encrypted": "Unknown",
  "noticeText": "Notice text",
  "copyrightText": "string",
  "repositoryItem": {
    "title": "string",
    "id": 0,
    "item": { … },
    "componentVersion": { … },
    "inUse": true,
    "component": { … },
    "createDate": "2019-08-24T14:15:22Z",
    "updateDate": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "license": 1,
    "licenseExpressionId": 0,
    "licenseExpression": { … }
  },
  "provenanceId": 0,
  "createDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "fileCount": 2000,
  "dependencyScope": "string",
  "links": [
    { … }
  ],
  "license": 1,
  "auditorReviewNotes": "good to go",
  "remediationNotes": "update this immediately",
  "workflowURL": "string",
  "associatedComponent": {
    "flagMask": 0,
    "popularity": 0,
    "sourceRepoUrl": "string",
    "modified": true,
    "title": "string",
    "description": "string",
    "name": "string",
    "id": 0,
    "default": true,
    "displayName": "string",
    "url": "string",
    "versions": [ … ],
    "createdBy": "string",
    "licenses": [ … ],
    "componentForge": { … },
    "componentCPEs": [ … ],
    "sortedVersions": [ … ],
    "custom": true,
    "externalId": "string",
    "updatedBy": "string",
    "encryption": true,
    "registeredDate": "2019-08-24T14:15:22Z",
    "lastUpdateDate": "2019-08-24T14:15:22Z",
    "sortedLicenses": [ … ],
    "type": "Component"
  },
  "associatedComponentVersion": {
    "id": 0,
    "type": "Component",
    "displayName": "string",
    "deprecated": true,
    "customVulnerabilities": [ … ],
    "licenses": [ … ],
    "component": { … },
    "vulnerabilities": [ … ],
    "versionName": "string",
    "purl": "string",
    "releaseDate": "2019-08-24T14:15:22Z",
    "versionLicenses": [ … ],
    "custom": true,
    "sortedLicenses": [ … ],
    "displayVersionName": "string"
  },
  "closedVulnerabilityAlerts": [
    { … }
  ],
  "openVulnerabilityAlerts": [
    { … }
  ],
  "asFoundLicenseText": "Sample from file LICENSE.txt in file ePortal-2.0"
}