Jump to

• Request
• Response

V5.0

post

/ec-designer-edc-svc/rest/v5.0/studies/{studyId}/lockObjectDetails

Returns lock-object details for selected study objects. The request body contains the objects to inspect, and the response includes matching visit, form, and item details based on the supplied mode and optional detail filters. Compared with v4.0, this version uses v5 response mapping and excludes view-query data from the returned details.

Request

Path Parameters

• studyId(required): string
  Study ID (UUID, 32-character uppercase hexadecimal string).

  Example:

  9F8E7D6C5B4A3210FEDCBA9876543210

• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

Query Parameters

• dynamicData: boolean
  Include dynamic data.

  Default Value: true

  Example:

  true

• excludeItemType: string
  Form item type to exclude from returned item details.

  Allowed Values: [ "instructionalText" ]

  Example:

  instructionalText

• items: string
  Optional hidden-item filter for returned lock-object details.

  Allowed Values: [ "all", "hiddenOnly" ]

  Example:

  all

• itemsIncluded: boolean
  Include items in response.

  Example:

  true

• mode(required): string
  Study mode

  Allowed Values: [ "test", "training", "active" ]

  Example:

  test

• showParent: string
  Optional hidden-parent-object filter for returned lock-object details.

  Allowed Values: [ "all", "hiddenOnly" ]

  Example:

  all

• showVisitDetails: boolean
  Include visit details.

  Example:

  true

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object RqstLockObjectDto

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

Nested Schema : RqstLockObjectDto

Type: object

Show Source

• objectId(required): string (uuid)
  Object ID. UUID, 32-character uppercase hexadecimal string.
• objectLockDate: string (date-time)
  Optional object lock date.
• objectLockVersion(required): string
  Title: ObjectLockVersion

  Study version where the object lock is evaluated.

  Example: 1.0.0.1
• objectType(required): string
  Title: ObjectType

  Allowed Values: [ "form", "visit" ]

  Type of study object to retrieve lock details for.

  Example: form
• parentObjectId: string (uuid)
  Parent object ID. UUID, 32-character uppercase hexadecimal string.

{
    "required":[
        "objectId",
        "objectLockVersion",
        "objectType"
    ],
    "type":"object",
    "properties":{
        "objectId":{
            "type":"string",
            "description":"Object ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "objectType":{
            "title":"ObjectType",
            "type":"string",
            "description":"Type of study object to retrieve lock details for.",
            "example":"form",
            "enum":[
                "form",
                "visit"
            ]
        },
        "parentObjectId":{
            "type":"string",
            "description":"Parent object ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "objectLockVersion":{
            "title":"ObjectLockVersion",
            "type":"string",
            "description":"Study version where the object lock is evaluated.",
            "example":"1.0.0.1"
        },
        "objectLockDate":{
            "type":"string",
            "description":"Optional object lock date.",
            "format":"date-time"
        }
    }
}

Examples

Select an example lockObjectRequest

Back to Top

Response

Supported Media Types

• application/json

200 Response

Lock object details were returned successfully.

Body ()

Root Schema : RespLockObjectDetailsDto

Type: object

Show Source

• visitObjects: object visitObjects
  Additional Properties Allowed: additionalProperties

  Locked visit object details.

{
    "type":"object",
    "properties":{
        "visitObjects":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "$ref":"#/components/schemas/LockObjectVersionDetailsDtoV5"
                },
                "description":"Locked visit object details."
            },
            "description":"Locked visit object details."
        }
    }
}

Nested Schema : visitObjects

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: LockObjectVersionDetailsDtoV5

  Locked visit object details.

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "$ref":"#/components/schemas/LockObjectVersionDetailsDtoV5"
        },
        "description":"Locked visit object details."
    },
    "description":"Locked visit object details."
}

Locked visit object details.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object LockObjectVersionDetailsDtoV5
  Title: LockObjectVersionDetailsDtoV5

  Information about all the locked objects in a version

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/LockObjectVersionDetailsDtoV5"
    },
    "description":"Locked visit object details."
}

Locked visit object details.

Nested Schema : LockObjectVersionDetailsDtoV5

Type: object

Title: LockObjectVersionDetailsDtoV5

Information about all the locked objects in a version

Show Source

• visitDetails: object VisitDto v10.0
  Title: VisitDto v10.0

  Visit design.

{
    "title":"LockObjectVersionDetailsDtoV5",
    "type":"object",
    "properties":{
        "visitDetails":{
            "$ref":"#/components/schemas/VisitDtoV10"
        }
    },
    "description":"Information about all the locked objects in a version"
}

Nested Schema : VisitDto v10.0

Type: object

Title: VisitDto v10.0

Visit design.

Show Source

• branchId: string (uuid)
  Branch Id
• branchTitle: string
  Visit Branch title

  Example: Branch 2
• endVisitId: string (uuid)
  End visit ID
• eventType: string
  Visit event type

  Example: ScreeningVisit
• fullName: string
  Concatenation of Visit Title and Branch title with hypen

  Example: B1C01 - V01
• id: string (uuid)
  Visit GUID
• lastRequired: boolean
  Yes - if Visit is last required.

  Example: false
• randomization: string (uuid)
  Randomization GUID
• repeatNumber(required): integer (int32)
  Times to repeat Visit Design.

  Example: 5
• repeatVisit(required): boolean
  Yes - if Visit Design is repeating.

  Example: false
• requiredVisit(required): boolean
  Yes - if Visit Design is required.

  Example: false
• sdvRequired: string
  Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]

  Source Data Verification Type

  Example: NOTSET(0),NEVER(1),ALWAYS(2),CRITICAL(3)
• shortName(required): string
  Minimum Length: 1

  Maximum Length: 16

  Pattern: [a-zA-Z0-9]+

  Visit short name

  Example: Week1
• startVisitId: string (uuid)
  Start visit ID
• studyVersion: string
  Study version

  Example: 1.0.0.1
• studyVersionStatus: string
  Study version status

  Example: TESTING
• timeLine: integer (int32)
  show in timeline. allows the designer to set when a visit can be shown to a user.

  Example: 1
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Visit title

  Example: Week 2
• visitDescription: string
  Visit description

  Example: Regular 2 week visit
• visitStartDate: string (date-time)
  Visit start date time

  Example: 2019-01-25T07:42:00.204Z

{
    "title":"VisitDto v10.0",
    "required":[
        "repeatNumber",
        "repeatVisit",
        "requiredVisit",
        "shortName",
        "title"
    ],
    "type":"object",
    "properties":{
        "branchTitle":{
            "type":"string",
            "description":"Visit Branch title",
            "example":"Branch 2"
        },
        "fullName":{
            "type":"string",
            "description":"Concatenation of Visit Title and Branch title with hypen",
            "example":"B1C01 - V01"
        },
        "id":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Visit title",
            "example":"Week 2"
        },
        "repeatVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is repeating.",
            "example":false
        },
        "repeatNumber":{
            "type":"integer",
            "description":"Times to repeat Visit Design.",
            "format":"int32",
            "example":5
        },
        "requiredVisit":{
            "type":"boolean",
            "description":"Yes - if Visit Design is required.",
            "example":false
        },
        "randomization":{
            "type":"string",
            "description":"Randomization GUID",
            "format":"uuid"
        },
        "lastRequired":{
            "type":"boolean",
            "description":"Yes - if Visit is last required.",
            "example":false
        },
        "eventType":{
            "type":"string",
            "description":"Visit event type",
            "example":"ScreeningVisit"
        },
        "shortName":{
            "maxLength":16,
            "minLength":1,
            "pattern":"[a-zA-Z0-9]+",
            "type":"string",
            "description":"Visit short name",
            "example":"Week1"
        },
        "visitDescription":{
            "type":"string",
            "description":"Visit description",
            "example":"Regular 2 week visit"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date time",
            "format":"date-time",
            "example":"2019-01-25T07:42:00.204Z"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version",
            "example":"1.0.0.1"
        },
        "studyVersionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"TESTING"
        },
        "startVisitId":{
            "type":"string",
            "description":"Start visit ID",
            "format":"uuid"
        },
        "endVisitId":{
            "type":"string",
            "description":"End visit ID",
            "format":"uuid"
        },
        "branchId":{
            "type":"string",
            "description":"Branch Id",
            "format":"uuid"
        },
        "timeLine":{
            "type":"integer",
            "description":"show in timeline. allows the designer to set when a visit can be shown to a user.",
            "format":"int32",
            "example":1
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NOTSET(0),NEVER(1),ALWAYS(2),CRITICAL(3)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        }
    },
    "description":"Visit design."
}

Examples

Select an example LockObjectDetailsDtoV5

500 Response

Unexpected server error while retrieving lock object details.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example serverError

Back to Top