Jump to

• Request
• Response

Get list of svf by study

get

/ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/svf

Retrieves a list of all SVFs by study ID and mode.

Request

Path Parameters

• mode(required): string
  Mode to fetch the record for
• studyId(required): string
  ID of the study for which you want to get the list of subjects.

Query Parameters

• limit: integer(int32)
  number of records
• offset: integer(int32)
  starting offset
• order: string
  asc or desc
• subjectId: string
  Subject ID to fetch the record 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 SignVerifyFreezeDTOv20

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

Nested Schema : SignVerifyFreezeDTOv20

Type: object

Show Source

• comment: string
  Minimum Length: 0

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

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

{
    "type":"object",
    "properties":{
        "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"
        },
        "formId":{
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "signed":{
            "type":"string"
        },
        "verify":{
            "type":"string"
        },
        "freeze":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        }
    }
}

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