Update existing rule.
Note: Value for detectionCriteria is an array of string Eg. detectionCriteria: ["filepath1 or folderpath1","filepath2 or folderpath2"].
Parameters fileInfo and ruleInfo are mutually exclusive. Only users with Library Manager role can update rules.
Update existing rule.
OK
Bad Request
Unauthorized
Internal Server Error
{- "id": 1,
- "inventoryName": "Custom Inventory Name",
- "componentId": 1,
- "versionId": 1,
- "licenseId": 1,
- "description": "description",
- "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"
}
], - "ruleInfo": [
- {
- "detectionType": "filePath",
- "detectionCriteria": "[filepath]"
}
]
}Add new rule with either file info or rule info.
Note: Value for detectionCriteria is an array of string Eg. detectionCriteria: ["filepath1 or folderpath1","filepath2 or folderpath2"].
Parameters fileInfo and ruleInfo are mutually exclusive. Only users with Library Manager role can create rules.
Add new rule.
Created
Bad Request
Unauthorized
Internal Server Error
{- "inventoryName": "Custom Inventory Name",
- "componentId": 1,
- "versionId": 1,
- "licenseId": 1,
- "description": "description",
- "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"
}
], - "ruleInfo": [
- {
- "detectionType": "filePath",
- "detectionCriteria": "[filepath]"
}
]
}Disable multiple rules by their IDs. Disabled rules will not be applied during project scanning. Only users with Library Manager role can disable rules.
List of rule IDs to disable
Rules disabled successfully
Bad Request - Rule IDs cannot be empty
Unauthorized
Forbidden - Insufficient permissions
Internal Server Error
[- 0
]Enable multiple rules. Enabled rules will be applied during project scanning. Only users with Library Manager role can enable rules.
List of rules ids to enable
Rules enabled successfully
Bad Request - Rule data cannot be empty or invalid
Unauthorized
Forbidden - Insufficient permissions
Internal Server Error
[- 0
]