Query: allLicenses

A license, typically a software license, which may be open source or proprietary

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterLicenseFilter
firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

orderByLicenseOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_instancesMeta_QueryMeta

All detections of software component instances that leverage this license

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

copyLeftCopyLeft

The type of CopyLeft license family, if applicable

createdAtDateTime

The instant this object has been created

fullLicenseNameString

The full name of the license

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

instances[SoftwareComponentInstance]

All detections of software component instances that leverage this license

isDeprecatedLicenseIdBoolean

Whether or not the license ID has been deprecated in official SPDX lists

isFsfLibreBoolean

Whether or not the license is a Free Software Foundation (FSF) approved or endorsed license. The FSF has specific criteria for what constitutes a "free" or "libre" software license.

Freedom 0: The freedom to run the program for any purpose. Freedom 1: The freedom to study how the program works and to modify it. Freedom 2: The freedom to redistribute copies so you can help others. Freedom 3: The freedom to distribute copies of your modified versions to others.

For more details, see https://www.gnu.org/licenses/license-list.en.html

isOsiApprovedBoolean

Whether or not the license is Open Source Initiative (OSI) approved. For more details, see https://opensource.org/licenses/

nameString

The name of the license, which is typically and SPDX compliant identifier

referenceNumberInt

The SPDX reference number for official licenses.

seeAlso[String]

Additional information about the license

spdxDetailsUrlString

A URL to the license text, or homepage of the group providing the license text

spdxReferenceUrlString

A URL that has information from SPDX about the license.

textEncodedData

The encoded data of the license itself

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)

urlString

A URL to the license text, or homepage of the group providing the license text


This page was generated: 2024-05-17