Jump to

• Request
• Response

Update a Rules File

put

/api/rule/Rules/{id}

Updates the properties of an existing rules file specified by the rule ID.

Request

Path Parameters

• id(required): string
  The path to the rules file to update, prefixed with id-. For example, to update the auto discovery base includes rules, use id-core/default/collection/discovery/auto/base.includes.

  Example:

  id-core

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClonedPath: string
  Path to cloned file

  Example: id-core/default/example_file
• CommitLog: string
  Text to enter as commit log for the change

  Example: Default Commit Message
• PathName: string
  Path to file

  Example: example_file
• RuleText: string
  Content of the rule

  Example: Testing

{
    "properties":{
        "CommitLog":{
            "description":"Text to enter as commit log for the change",
            "type":"string",
            "example":"Default Commit Message"
        },
        "PathName":{
            "description":"Path to file",
            "type":"string",
            "example":"example_file"
        },
        "ClonedPath":{
            "description":"Path to cloned file",
            "type":"string",
            "example":"id-core/default/example_file"
        },
        "RuleText":{
            "description":"Content of the rule",
            "type":"string",
            "example":"Testing"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• message: string
  The response message.

  Example: Updated rules file
• success: boolean
  Whether the operation was a success (true) or failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated rules file"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top