REST API for Clinical One Platform

Get visits and forms actions information

get

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

Retrieves information about visits and forms related actions.

Request

Path Parameters

formId(required): string(uuid)

Form Id
studyId(required): string(uuid)

Study Id
version(required): string

Study Version

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

Read Only: true

Response from Rule Designer APIs

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

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Result Object
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",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object

500 Response

No data found for supplied parameters.

Root Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

result: object result

Read Only: true

Result Object
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",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result Object