Get a project version inclusions report
get
https://{your_site_interface}/opa-hub/api/12.2.35/projects/{project-name}/versions/{project-version-version}/inclusions-report
This operation will get a project version inclusions report as a JSON array. To receive the report as CSV data, send an HTTP Accept header of "Accept: text/csv".
Request
Path Parameters
-
project-name(required): string
The name of the project.
-
project-version-version(required): integer(int64)
The automatically assigned version number
Query Parameters
-
expand: string
Comma separated list of named resources to expand, or "all" to expand all
-
fields: string
Comma separated list of fields to be returned
-
links: string
Comma separated list of links to be returned, or "none" to omit links
There's no request body for this operation.
Security
-
Authorization: apiKey
Type:
apiKey
Description:Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
-
oauth2_opa: oauth2
Type:
oauth2
Description:POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.
Response
Supported Media Types
- application/json
- text/csv
200 Response
The request was successfully completed.
Root Schema : projectVersionInclusionsReport
Type:
Show Source
object
-
inclusions: array
inclusions
Read Only:
true
Contains a flat array of all the project names and versions included by this project version.
Nested Schema : inclusions
Type:
array
Read Only:
true
Contains a flat array of all the project names and versions included by this project version.
Show Source
Nested Schema : projectVersionInclusionsReportInclusion
Type:
Show Source
object
-
inclusionLatestVersion: integer
(int64)
The latest version of the included project.
-
inclusionName(required): string
The name of the included project.
-
inclusionVersion(required): integer
(int64)
The version of the included project.
-
projectName(required): string
The name of the including project.
-
projectVersion(required): integer
(int64)
The version of the including project.
-
upToDateFlag(required): boolean
A flag indicating whether the included project is the latest version.