REST API for Clinical One Platform

Validate organization fields

post

/ec-site-svc/rest/v1.0/organizations/validateFields

Validate organization fields present in input payload and returns the corresponding flag as true or false.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

organizationFields: array organizationFields

{
    "type":"object",
    "properties":{
        "organizationFields":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FieldDto"
            }
        }
    }
}

Nested Schema : organizationFields

Type: array

Show Source

Array of: object FieldDto

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

Nested Schema : FieldDto

Type: object

Show Source

fieldName: string
fieldValue: string
valueExists: boolean

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string"
        },
        "fieldValue":{
            "type":"string"
        },
        "valueExists":{
            "type":"boolean"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

400 Response

Bad request.

Root Schema : SDFResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object