REST API for Clinical One Cloud Service

v1.0

post

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/validateFields

Validate study labs, depots or sites fields present in input payload and returns the corresponding flag as true or false.

Request

Path Parameters

mode(required): string
Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).
Example:
```
test
```
sdfType(required): string
SDF type filter. Allowed values: site/SITE (site records), depot/DEPOT (depot records), lab/LAB (lab records), all/ALL (all supported SDF types).
Example:
```
site
```
studyId(required): string(uuid)
Study identifier as a 32-character uppercase hexadecimal UUID string.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

sdfFields: array sdfFields

{
    "type":"object",
    "properties":{
        "sdfFields":{
            "type":"array",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/Field"
            }
        }
    }
}

Nested Schema : sdfFields

Type: array

Show Source

Array of: object Field

Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.

{
    "type":"array",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/Field"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : Field

Type: object

Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.

Show Source

fieldName(required): string

Minimum Length: 1

Maximum Length: 255

Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.

Example: ruleState
fieldSequence: integer (int32)

Minimum Value: 0

Maximum Value: 2147483647

Sequence/order of the field. Provide a non-negative integer.

Example: 1
fieldType(required): string

Minimum Length: 4

Maximum Length: 16

Allowed Values: [ "list", "date", "date-time", "number", "string", "boolean" ]

Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.

Example: list
fieldValueList(required): array fieldValueList

List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.

{
    "required":[
        "fieldName",
        "fieldType",
        "fieldValueList"
    ],
    "type":"object",
    "properties":{
        "fieldName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Field name to evaluate. Examples include STUDYID, SITEID, ruleState, and dateRange.",
            "example":"ruleState"
        },
        "fieldType":{
            "maxLength":16,
            "minLength":4,
            "type":"string",
            "description":"Field value classification. Use list for enumerations, date for calendar values, date-time for timestamps, number for numeric filters, string for textual filters, or boolean for true/false.",
            "example":"list",
            "enum":[
                "list",
                "date",
                "date-time",
                "number",
                "string",
                "boolean"
            ]
        },
        "fieldSequence":{
            "maximum":2147483647,
            "minimum":0,
            "type":"integer",
            "description":"Sequence/order of the field. Provide a non-negative integer.",
            "format":"int32",
            "example":1
        },
        "fieldValueList":{
            "type":"array",
            "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ],
            "items":{
                "maxLength":256,
                "minLength":1,
                "type":"string",
                "example":"publish"
            }
        }
    },
    "description":"Generic representation of a report filter. Each entry specifies the field to evaluate, its data type, and the values to use when filtering.",
    "example":{
        "fieldName":"ruleState",
        "fieldType":"list",
        "fieldSequence":1,
        "fieldValueList":[
            "approved"
        ]
    }
}

Example:

{
    "fieldName":"ruleState",
    "fieldType":"list",
    "fieldSequence":1,
    "fieldValueList":[
        "approved"
    ]
}

Nested Schema : fieldValueList

Type: array

List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 256

Example: publish

{
    "type":"array",
    "description":"List of values for the Field. Provide GUIDs for identifier filters or literal values for textual filters.",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ],
    "items":{
        "maxLength":256,
        "minLength":1,
        "type":"string",
        "example":"publish"
    }
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

errorData: object ErrorResponseData
result: object result

The result object for successful requests. Type depends on the API operation.
status: string

Status of the response, either 'success' or an error indication.

Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

errorData: object ErrorResponseData
result: object result

The result object for successful requests. Type depends on the API operation.
status: string

Status of the response, either 'success' or an error indication.

Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples