Jump to

• Request
• Response

Delete rules in bulk

put

/ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkdelete

Removes rules in bulk.

Request

Path Parameters

• mode(required): string
  Study Mode. (Test, Training or Active)

  Example:

  test

• studyId(required): string(uuid)
  Study ID.

  Example:

  36753A48BBA048CB98A5F3278146118D

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ruleIds(required): array ruleIds
  list of Rule Unique GUIDs

{
    "required":[
        "ruleIds"
    ],
    "type":"object",
    "properties":{
        "ruleIds":{
            "type":"array",
            "description":"list of Rule Unique GUIDs",
            "format":"uuid",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of Rule Unique GUIDs",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : ruleIds

Type: array

list of Rule Unique GUIDs

Show Source

• Array of: string(uuid)
  list of Rule Unique GUIDs

{
    "type":"array",
    "description":"list of Rule Unique GUIDs",
    "format":"uuid",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of Rule Unique GUIDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Bulk delete rules was successful.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Http Error Code

  Example: 400
• httpErrorMessage: string
  Http Error Message

  Example: Bad Request
• jobId: string (uuid)
  Job Id
• jobStatus: string
  Job Status

  Example: IN_PROGRESS
• result: object RDSRestResponseDTO
  Response from Rule Designer APIs
• Rule Validation Message: string
  Rule Validation Message

  Example: Rule is valid
• Rule Validation Status: boolean
  Rule Validation State

  Example: true
• ruleId: string (uuid)
  Rule Id
• ruleName: string
  Rule Name

  Example: My Rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"My Rule"
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"IN_PROGRESS"
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"Rule is valid"
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "example":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "example":400
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "example":"Bad Request"
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

Error details from Rule Designer APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message
• result: string
  Read Only: true

  Result
• status: string
  Read Only: true

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object. Refer to example response for more details.
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object. Refer to example response for more details.",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "example":{
        "status":"success",
        "result":"Rule executed successfully"
    }
}

Example:

{
    "status":"success",
    "result":"Rule executed successfully"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

400 Response

Incorrect payload.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Http Error Code

  Example: 400
• httpErrorMessage: string
  Http Error Message

  Example: Bad Request
• jobId: string (uuid)
  Job Id
• jobStatus: string
  Job Status

  Example: IN_PROGRESS
• result: object RDSRestResponseDTO
  Response from Rule Designer APIs
• Rule Validation Message: string
  Rule Validation Message

  Example: Rule is valid
• Rule Validation Status: boolean
  Rule Validation State

  Example: true
• ruleId: string (uuid)
  Rule Id
• ruleName: string
  Rule Name

  Example: My Rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"My Rule"
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"IN_PROGRESS"
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"Rule is valid"
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "example":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "example":400
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "example":"Bad Request"
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

Error details from Rule Designer APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message
• result: string
  Read Only: true

  Result
• status: string
  Read Only: true

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object. Refer to example response for more details.
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object. Refer to example response for more details.",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "example":{
        "status":"success",
        "result":"Rule executed successfully"
    }
}

Example:

{
    "status":"success",
    "result":"Rule executed successfully"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

500 Response

An internal error occurred.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Http Error Code

  Example: 400
• httpErrorMessage: string
  Http Error Message

  Example: Bad Request
• jobId: string (uuid)
  Job Id
• jobStatus: string
  Job Status

  Example: IN_PROGRESS
• result: object RDSRestResponseDTO
  Response from Rule Designer APIs
• Rule Validation Message: string
  Rule Validation Message

  Example: Rule is valid
• Rule Validation Status: boolean
  Rule Validation State

  Example: true
• ruleId: string (uuid)
  Rule Id
• ruleName: string
  Rule Name

  Example: My Rule

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid"
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "example":"My Rule"
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid"
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "example":"IN_PROGRESS"
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "example":"Rule is valid"
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "example":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "example":400
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "example":"Bad Request"
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

Error details from Rule Designer APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message
• result: string
  Read Only: true

  Result
• status: string
  Read Only: true

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "example":{
        "errorCode":"RULE_ERROR",
        "errorMessage":"Rule execution failed"
    }
}

Example:

{
    "errorCode":"RULE_ERROR",
    "errorMessage":"Rule execution failed"
}

Nested Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object. Refer to example response for more details.
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object. Refer to example response for more details.",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "example":{
        "status":"success",
        "result":"Rule executed successfully"
    }
}

Example:

{
    "status":"success",
    "result":"Rule executed successfully"
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

Back to Top