Jump to

• Request
• Response

Get multiple parameters of all rules in a study

get

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

Retrieves the following data for all rules: name, ID, rulerefname, ruleState, ruleDeleted, ruleEnabled, ruleValidationStatus and studymode for a given study ID and mode. Allows optional filters such as ruleState, ruleDeleted, ruleEnabled, and ruleValidationStatus.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  36753A48BBA048CB98A5F3278146118D

Query Parameters

• ruleDeleted: number
  Rule Deleted: can be 0/1 - Optional Filter.

  Example:

  1

• ruleEnabled: number
  Rule Enabled (1/0) - Optional Filter.

  Example:

  0

• ruleState: string
  Rule State: can be draft, uat, approved, publish - Optional Filter.

  Example:

  draft

• ruleValidationStatus: string
  Rule Validation Status (true/false) - Optional Filter.

  Example:

  true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object RDSRestResponseDTO
  Response from Rule Designer APIs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RDSRestResponseDTO"
    }
}

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 : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

Examples

Select an example Example response for a successful bulk update rules request

400 Response

Bad request.

Body ()

Root 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 : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

500 Response

No data found for supplied parameters.

Body ()

Root 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 : result

Type: object

Read Only: true

Result Object. Refer to example response for more details.

Back to Top