REST API for Clinical One Cloud Service

v1.0

get

/ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/versions/{version}/formId/{formId}

Retrieves information about visits/forms related actions.

Request

Path Parameters

formId(required): string(uuid)
Optional form identifier filter. Accepts either a compact 32-character hexadecimal UUID or a hyphenated 36-character UUID.
Example:
```
38891F5E75BB4071BBF8ACE1F43BD1BD
```
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
```
version(required): string
Optional study version value. Provide the semantic version string that uniquely identifies the study draft.
Example:
```
3.2.0.18
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success.

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

500 Response

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

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