Rules

Get Rules

Get existing custom rules.

Request

query Parameters

offset	integer <int32> Default: 1 Index of the page to start with. Example: offset=1 \| default: 1
limit	integer <int32> Default: 25 Number of records to fetch. Example: limit=25 \| default: 25

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/rules

Create Rule

Add new rule.

Request

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Add new rule.

componentId required	integer <int64> >= 1 componentId
versionId required	integer <int64> >= 1 versionId
licenseId required	integer <int64> >= 1 licenseId
description	string description
url	string [ 0 .. 2400 ] characters (NA\|^https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=... url
noticesText	string noticesText
auditNotes	string auditNotes
asFoundLicenseText	string asFoundLicenseText
	Array of objects (FileInfo) fileInfo

Responses

201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/rules

Request samples

Payload

application/json

{"componentId": "1",
"versionId": "1",
"licenseId": "1",
"description": "description",
"url": "https://www.flexera.com/",
"noticesText": "Sample Notices Text",
"auditNotes": "Sample Audit Notes",
"asFoundLicenseText": "Sample from file LICENSE.txt in file @file in the materials",
"fileInfo": [{"name": "fileName",
"md5": "md5"
}
]
}

Update Rule

Update existing rule.

Request

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Request Body schema: application/json

Update existing rule.

id	integer <int64> id
componentId required	integer <int64> >= 1 componentId
versionId required	integer <int64> >= 1 versionId
licenseId required	integer <int64> >= 1 licenseId
description	string description
url	string [ 0 .. 2400 ] characters (NA\|^https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=... url
noticesText	string noticesText
auditNotes	string auditNotes
asFoundLicenseText	string asFoundLicenseText
	Array of objects (FileInfo) fileInfo

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

put/rules

Request samples

Payload

application/json

{"id": "1",
"componentId": "1",
"versionId": "1",
"licenseId": "1",
"description": "description",
"url": "https://www.flexera.com/",
"noticesText": "Sample Notices Text",
"auditNotes": "Sample Audit Notes",
"asFoundLicenseText": "Sample from file LICENSE.txt in file @file in the materials",
"fileInfo": [{"name": "fileName",
"md5": "md5"
}
]
}

Get Rule By ID

Get existing rule by ruleId.

Request

path Parameters

ruleId

required

integer <int64>

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/rules/{ruleId}

Delete Rule

Delete existing rule.

Request

path Parameters

ruleId

required

integer <int64>

header Parameters

Authorization

required

string

Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/rules/{ruleId}

➔ Next to Scan API