Powered by Redocly

license

License Lookup

Returns id, name, priority, url, description, text, shortName and spdxIdentifier for a given license ID or license Name.

SecuritybearerAuth
Request
query Parameters
licenseId
integer <int64>

ID of the license (Example: 1)

licenseName
string

Full name of the license (Example: Apache License 1.1)

Responses
200

OK

400

Bad request

500

Internal Server Error

get/license/lookup
Response samples
application/json
"string"

Create a custom license

Creates a custom license

SecuritybearerAuth
Request
Request Body schema: application/json
required

To create a custom license the name, shortName and licenseText is required.
Only users with Library Manager permission can create custom licenses.
Allowable values for familyName(Optional) are:
GNU LGPL 2.1 Style | Artistic License 1.0 Style | Proprietary Style | BSD 3-Clause Style | Apache 1.1 Style | CPL 1.0 Style | MIT Style | Public Domain Style | MPL 1.1 Style | MPL 1.0 Style | Academic Free License Style | Apache 2.0 Style | Sleepycat Style | EPL 1.0 Style | CDDL 1.0 Style | Commercial Style | GNU GPL 3 Style | GNU LGPL 2.0 Style | GNU LGPL 3.0 Style | GNU AGPL 3.0 Style | Ambiguous License Style | GNU GPL 2 Style | Artistic License 2.0 Style | BSD 2-Clause Style | GNU GPL 2 w/CPE Style | CDDL 1.1 Style | Apache 1.0 Style | BSD 4-Clause Style | GNU GPL 2+ Style | GNU GPL 3+ Style | GNU LGPL 2.1+ Style | GNU LGPL 3.0+ Style | GNU LGPL 2.0+ Style | MirOS Style | zlib Style | GNU GPL Style | GNU LGPL Style | GNU AGPL 3.0+ Style

name
string [ 0 .. 127 ] characters

name

shortName
string [ 0 .. 255 ] characters

shortName

licenseText
string [ 0 .. 16777215 ] characters

licenseText

priority
stringP1|P2|P3

priority

Enum: "P1" "P2" "P3"
url
string [ 0 .. 2400 ] characters (^https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2...

url

description
string [ 0 .. 65535 ] characters

description

familyName
string

familyName

externalId
string

externalId

Responses
201

Created

400

Bad Request

500

Internal Server Error

post/licenses
Request samples
application/json
{
  • "name": "General Public License",
  • "shortName": "GPL",
  • "licenseText": "License Text",
  • "priority": "E.g. P1 | P2 | P3 | default: P3",
  • "url": "https://abc.xyz",
  • "description": "License description",
  • "familyName": "License family",
  • "externalId": "External License Id Eg: 156"
}

Edit Custom License

Only users with Library Manager permission can edit a custom license.

SecuritybearerAuth
Request
path Parameters
licenseId
required
integer <int64>

ID of License

Example: 1
Request Body schema: application/json
required
name
string [ 0 .. 127 ] characters

name

shortName
string [ 0 .. 255 ] characters

shortName

licenseText
string [ 0 .. 16777215 ] characters

licenseText

priority
stringP1|P2|P3

priority

Enum: "P1" "P2" "P3"
url
string [ 0 .. 2400 ] characters (^https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2...

url

description
string [ 0 .. 65535 ] characters

description

familyName
string

familyName

externalId
string

externalId

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/licenses/{licenseId}
Request samples
application/json
{
  • "name": "General Public License",
  • "shortName": "GPL",
  • "licenseText": "License Text",
  • "priority": "E.g. P1 | P2 | P3 | default: P3",
  • "url": "https://abc.xyz",
  • "description": "License description",
  • "familyName": "License family",
  • "externalId": "External License Id Eg: 156"
}

Delete a custom license

Delete a custom license using the license ID. All existing inventory that uses this license will have its license changed to Unknown. You must have the Library Manager permission to delete a custom license.

SecuritybearerAuth
Request
path Parameters
licenseId
required
integer <int64>

ID of the License

Example: 1
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/licenses/{licenseId}

Update Licenses External Id

Update Licenses External Id. Only users with Library Manager permission can update the External Id of a license. The licenseId should be a valid license id and the externalId should not exceed 255 characters.

SecuritybearerAuth
Request
path Parameters
licenseId
required
integer <int64>

ID of the license

Example: 1
Request Body schema: application/json
externalId
string

externalId

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

patch/licenses/{licenseId}
Request samples
application/json
{
  • "externalId": "External License Id Eg:156"
}

Get All Licenses

Returns all license details. If onlyCustom is true, returns only custom licenses. Supports pagination with page and size parameters.

SecuritybearerAuth
Request
query Parameters
onlyCustom
boolean
Default: false

If true, returns only custom licenses

page
integer <int64>
Default: 1

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

size
integer <int64>
Default: 25

Page Size. Number Of Records to fetch per page

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/licenses/listAll

License lookup based on short name

Returns id, name, priority, url, description, text and spdxIdentifier for a given shortName.

SecuritybearerAuth
Request
path Parameters
shortName
required
string

Short name of the license

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/licenses/{shortName}
➔ Next to sourceCodeManagement