REST API for Clinical One Platform

~~[Deprecated]: Execute rules for the deleted repeating form items~~

put

/ec-rule-svc/rest/v2.0/studies/{studyId}/{mode}/deleteform

Deprecated: Use latest version instead. Executes rules associated with deleted repeating form items (itemIds ['253DE8D3112F45789741131FB98D2590', 'D75D4975E09F440286627303D95D4932']) on a form or a visit property.

Request

Path Parameters

mode(required): string

Study Mode.
studyId(required): string

Study ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

eventId: string
eventInstanceNumber: number
formId: string
formSectionId: string
itemId: string
itemIds: array itemIds

Unique Items Required: true
property: string
repeatSequenceNumber: number
siteId: string
studyId: string
studyName: string
studyVersion: string
subjectId: string

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string"
        },
        "studyName":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "property":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"number"
        },
        "eventInstanceNumber":{
            "type":"number"
        },
        "itemId":{
            "type":"string"
        },
        "itemIds":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "formSectionId":{
            "type":"string"
        }
    }
}

Nested Schema : itemIds

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Rule execution was successful.

Root Schema : ExecuteRuleTOv2

Type: object

Show Source

message: string
ruleTargets: array ruleTargets
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "ruleTargets":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ruleTargets

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

An internal error occurred.

Root Schema : ExecuteRuleTOv2

Type: object

Show Source

message: string
ruleTargets: array ruleTargets
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "ruleTargets":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ruleTargets

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}