REST API for Clinical One Platform

Update safety case status

put

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/safetycase/{id}

Updates the safety case status based on ID.

Request

Path Parameters

id(required): string(uuid)

Safety case ID.
mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study to which the safety case is associated.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

comment: string
externalSafetyCaseId: string
reason: string
status: string

Minimum Length: 0

Maximum Length: 100

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "externalSafetyCaseId":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SafetyCase

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

Nested Schema : SafetyCase

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
createdDate: string (date-time)
dataelementsInSafetyCase: array dataelementsInSafetyCase
extSafetyCaseId: string
id: string (uuid)
lastSubmittedDate: string (date-time)
modifiedDate: string (date-time)
operationType: string

Minimum Length: 1

Maximum Length: 16
reason: string

Minimum Length: 0

Maximum Length: 255
reporterIds: array reporterIds
safetyCaseData: array safetyCaseData
status: string
studyVersion: string
subjectId: string (uuid)
userId: string (uuid)
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "modifiedDate":{
            "type":"string",
            "format":"date-time"
        },
        "extSafetyCaseId":{
            "type":"string"
        },
        "lastSubmittedDate":{
            "type":"string",
            "format":"date-time"
        },
        "safetyCaseData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SafetyCaseData"
            }
        },
        "dataelementsInSafetyCase":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataElement"
            }
        },
        "reporterIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : dataelementsInSafetyCase

Type: array

Show Source

Array of: object DataElement

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

Nested Schema : reporterIds

Type: array

Show Source

Array of: string(uuid)

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

Nested Schema : safetyCaseData

Type: array

Show Source

Array of: object SafetyCaseData

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

Nested Schema : DataElement

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dataEventType: string
dataFlag: string (uuid)
dataflagValue: string
dateTimeValueUTC: string (date-time)
dayValue: integer
documentId: string (uuid)
documentVersion: number
eventId: string
eventInstanceNum: integer
floatValue: number
formId: string
formSectionId: string
freezedStatus: string
hdiId: string
hourValue: integer
id: string (uuid)
innerRepeat: integer
isSafetyDefaultSelected: boolean
isSafetyTrigger: boolean
itemD: string

Minimum Length: 0

Maximum Length: 4000
itemF: string

Minimum Length: 0

Maximum Length: 4000
itemId: string
itemR: string

Minimum Length: 0

Maximum Length: 4000
itemType: string

Minimum Length: 0

Maximum Length: 255
lockedDateTime: string (date-time)
lockedStatus: string
measureUnit: string

Minimum Length: 0

Maximum Length: 64
minuteValue: integer
monthValue: integer
normalizedUnitId: string
normalizedValue: string
numValue: integer
operationType: string

Minimum Length: 1

Maximum Length: 16
originatorId: string
outerRepeat: integer
propertyId: string
propertyVersionStart: string (date-time)
reason: string

Minimum Length: 0

Maximum Length: 255
repeatFormNumber: integer
repeatSequenceNumber: integer
secondValue: integer
signedStatus: string
siteId: string
studyId: string
studyName: string

Minimum Length: 0

Maximum Length: 100
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
transactionEnd: string (date-time)
transactionStart: string (date-time)
userId: string (uuid)
validationFailure: string
validationRules: array validationRules
validationStatus: string
value: string

Minimum Length: 0

Maximum Length: 4000
variableId: string
vendorCode: string

Minimum Length: 0

Maximum Length: 100
verifiedStatus: string
versionStart: string (date-time)
visitStartDate: string (date-time)
visitStatus: string

Allowed Values: [ "NEW", "COMPLETE", "COMPLETE_ERR", "INPROGRESS", "INCOMPLETE", "INCOMPLETE_ERR", "SKIPPED", "UNDO_SKIP", "NOT_STARTED" ]
yearValue: integer

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "type":"string"
        },
        "validationFailure":{
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "measureUnit":{
            "maxLength":64,
            "minLength":0,
            "type":"string"
        },
        "normalizedValue":{
            "type":"string"
        },
        "normalizedUnitId":{
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "dateTimeValueUTC":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "dataFlag":{
            "type":"string",
            "format":"uuid"
        },
        "itemD":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "itemR":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "itemF":{
            "maxLength":4000,
            "minLength":0,
            "type":"string"
        },
        "itemType":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "propertyId":{
            "type":"string"
        },
        "propertyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "dataEventType":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "hdiId":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStatus":{
            "type":"string",
            "enum":[
                "NEW",
                "COMPLETE",
                "COMPLETE_ERR",
                "INPROGRESS",
                "INCOMPLETE",
                "INCOMPLETE_ERR",
                "SKIPPED",
                "UNDO_SKIP",
                "NOT_STARTED"
            ]
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "isSafetyTrigger":{
            "type":"boolean"
        },
        "isSafetyDefaultSelected":{
            "type":"boolean"
        },
        "dataflagValue":{
            "type":"string"
        },
        "documentId":{
            "type":"string",
            "format":"uuid"
        },
        "documentVersion":{
            "type":"number"
        },
        "validationRules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ValidationRuleDto"
            }
        }
    }
}

Nested Schema : validationRules

Type: array

Show Source

Array of: object ValidationRuleDto

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

Nested Schema : ValidationRuleDto

Type: object

Show Source

queryId: string
queryStatus: string
ruleId: string

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string"
        },
        "queryId":{
            "type":"string"
        },
        "queryStatus":{
            "type":"string"
        }
    }
}

Nested Schema : SafetyCaseData

Type: object

Show Source

associated: boolean
comment: string

Minimum Length: 0

Maximum Length: 2048
defaultSelected(required): string

Minimum Length: 0

Maximum Length: 1
eventId(required): string (uuid)
eventInstNum: integer
extSafetyCaseId: string
formId(required): string (uuid)
id: string (uuid)
innerRepNum: integer
operationType: string

Minimum Length: 1

Maximum Length: 16
outerRepNum: integer
reason: string

Minimum Length: 0

Maximum Length: 255
safetyCaseId(required): string (uuid)
safetyCaseTitle: string
status: string
subjectId: string (uuid)
triggerItemId: string (uuid)
userId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "defaultSelected",
        "eventId",
        "formId",
        "safetyCaseId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "safetyCaseId":{
            "type":"string",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstNum":{
            "type":"integer"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "outerRepNum":{
            "type":"integer"
        },
        "innerRepNum":{
            "type":"integer"
        },
        "defaultSelected":{
            "maxLength":1,
            "minLength":0,
            "type":"string"
        },
        "triggerItemId":{
            "type":"string",
            "format":"uuid"
        },
        "associated":{
            "type":"boolean"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "status":{
            "type":"string"
        },
        "extSafetyCaseId":{
            "type":"string"
        },
        "safetyCaseTitle":{
            "type":"string"
        }
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "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