Jump to

• Request
• Response

Locks data elements in a subject

post

/ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/lock/allvisit

This API locks the items, forms and visit for a subject.

Request

Path Parameters

• mode(required): string
  Mode to fetch the records for
• studyId(required): string
  ID of the study to fetch the records for
• subjectId(required): string(uuid)
  Subject ID to fetch the records for

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DataActionsDTO

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

Nested Schema : DataActionsDTO

Type: object

Show Source

• action: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• eventId: string (uuid)
• eventInstanceNum: integer
• formId: string (uuid)
• formSectionId: string (uuid)
• id: string (uuid)
• innerRepeat: integer
• itemId: string (uuid)
• objectVersionNumber: number
• operationType: string
• outerRepeat: integer
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• repeatFormNumber: integer
• repeatSequenceNumber: integer
• siteId: string (uuid)
• softwareVersionNumber: number
• studyVersion: string
• subjectId: string (uuid)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• visitStartDateAction: string

{
    "type":"object",
    "properties":{
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "action":{
            "type":"string"
        },
        "visitStartDateAction":{
            "type":"string"
        }
    }
}

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

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

Back to Top