Update single InHouse Rule

SCA API 2.0

Update single InHouse Rule

Request

Updates a single In-House library rule

Security

bearer-key

Path

orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

ruleUuidstringrequired

The In-House rule UUID

Bodyapplication/jsonrequired

typestring(InHouse Rule Regex Type)

Enum:"NAME""LIBRARY_COORDINATES""ARTIFACT_ID"

Example:"NAME"

regexstring(InHouse Regex Rule)

Example:"*aa*"

descriptionstring(InHouse Description)

Example:"description for InHouse rule"

emptyboolean

PUT

/api/v2.0/orgs/{orgToken}/settings/inHouse/{ruleUuid}

{
  "type": "NAME",
  "regex": "*aa*",
  "description": "description for InHouse rule",
  "empty": true
}

Responses

Bodyapplication/json

additionalDataobject(Provides warning messages for notifying about conditions related to the )

warningMessage: Serves as an alert to inform you about the status of the rule being updated. The warning message will provide information about whether the rule already exists or if some of the rules are already present

Example:

{
  "warningMessage": "item already exists"
}

supportTokenstring(Support Token)

Example:"1171c60d"

retValobject(InHouseRuleDTO)

Response

{
  "additionalData": {
    "warningMessage": "item already exists"
  },
  "supportToken": "1171c60d",
  "retVal": {
    "uuid": "string",
    "type": "NAME",
    "regex": ".*a*",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "empty": true
  }
}