Jump to

• Request
• Response

v1.0

post

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

Retrieves the rule operands that belong to a specified rule IDs.

Request

Path Parameters

• mode(required): string
  Study mode determines the data segment being managed. Allowed values: design (draft configuration workspace), test (UAT sandbox), training (sandbox for practice data), production (live subject data).

  Example:

  test

• studyId(required): string(uuid)
  Unique study identifier supplied as a UUID. Accepts either a compact 32-character hexadecimal value or a hyphenated 36-character UUID.

  Example:

  36753A48BBA048CB98A5F3278146118D

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : RuleIDsReq

Type: object

Title: RuleIDsReq

List of Rule Ids

Show Source

• ruleIds: array ruleIds
  List of Unique ID of rule

{
    "title":"RuleIDsReq",
    "type":"object",
    "properties":{
        "ruleIds":{
            "type":"array",
            "description":"List of Unique ID of rule",
            "example":"[B1B8327AFAA6412287106192AB5984EF]",
            "items":{
                "type":"string",
                "description":"List of Unique ID of rule",
                "format":"uuid"
            }
        }
    },
    "description":"List of Rule Ids"
}

Nested Schema : ruleIds

Type: array

List of Unique ID of rule

Show Source

• Array of: string(uuid)
  List of Unique ID of rule

{
    "type":"array",
    "description":"List of Unique ID of rule",
    "example":"[B1B8327AFAA6412287106192AB5984EF]",
    "items":{
        "type":"string",
        "description":"List of Unique ID of rule",
        "format":"uuid"
    }
}

Example:

[B1B8327AFAA6412287106192AB5984EF]

Examples

Select an example List of rule IDs to fetch operands

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

  Maximum Number of Properties: 2000

  Result payload when the request succeeds. Structure depends on the endpoint.
• status: string
  Read Only: true

  Minimum Length: 6

  Maximum Length: 7

  Allowed Values: [ "success", "failed" ]

  Overall outcome for the call. Allowed values: success, failed.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":7,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome for the call. Allowed values: success, failed.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "maxProperties":2000,
            "type":"object",
            "description":"Result payload when the request succeeds. Structure depends on the endpoint.",
            "readOnly":true,
            "example":{
                "rules":[
                ]
            }
        }
    },
    "description":"Response from Rule Designer APIs",
    "nullable":true,
    "example":{
        "status":"success",
        "result":{
            "message":"Rule updated successfully."
        }
    }
}

Example:

{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}

Nested Schema : result

Type: object

Read Only: true

Maximum Number of Properties: 2000

Result payload when the request succeeds. Structure depends on the endpoint.

Example:

{
    "rules":[
    ]
}

Examples

Select an example Success

400 Response

Returned when the supplied parameters fail validation or use an unsupported combination of filter values.

Body ()

Root Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Maximum Number of Properties: 2000

  Result payload when the request succeeds. Structure depends on the endpoint.
• status: string
  Read Only: true

  Minimum Length: 6

  Maximum Length: 7

  Allowed Values: [ "success", "failed" ]

  Overall outcome for the call. Allowed values: success, failed.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":7,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome for the call. Allowed values: success, failed.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "maxProperties":2000,
            "type":"object",
            "description":"Result payload when the request succeeds. Structure depends on the endpoint.",
            "readOnly":true,
            "example":{
                "rules":[
                ]
            }
        }
    },
    "description":"Response from Rule Designer APIs",
    "nullable":true,
    "example":{
        "status":"success",
        "result":{
            "message":"Rule updated successfully."
        }
    }
}

Example:

{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}

Nested Schema : result

Type: object

Read Only: true

Maximum Number of Properties: 2000

Result payload when the request succeeds. Structure depends on the endpoint.

Example:

{
    "rules":[
    ]
}

Examples

Select an example BadRequest

500 Response

Returned when no data is available for the supplied study context or identifiers.

Body ()

Root Schema : RDSRestResponseDTO

Type: object

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Maximum Number of Properties: 2000

  Result payload when the request succeeds. Structure depends on the endpoint.
• status: string
  Read Only: true

  Minimum Length: 6

  Maximum Length: 7

  Allowed Values: [ "success", "failed" ]

  Overall outcome for the call. Allowed values: success, failed.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":7,
            "minLength":6,
            "type":"string",
            "description":"Overall outcome for the call. Allowed values: success, failed.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success",
                "failed"
            ]
        },
        "result":{
            "maxProperties":2000,
            "type":"object",
            "description":"Result payload when the request succeeds. Structure depends on the endpoint.",
            "readOnly":true,
            "example":{
                "rules":[
                ]
            }
        }
    },
    "description":"Response from Rule Designer APIs",
    "nullable":true,
    "example":{
        "status":"success",
        "result":{
            "message":"Rule updated successfully."
        }
    }
}

Example:

{
    "status":"success",
    "result":{
        "message":"Rule updated successfully."
    }
}

Nested Schema : result

Type: object

Read Only: true

Maximum Number of Properties: 2000

Result payload when the request succeeds. Structure depends on the endpoint.

Example:

{
    "rules":[
    ]
}

Examples

Select an example ServerError

Back to Top