Jump to

• Request
• Response

[Deprecated]: V4.0

post

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

Deprecated: Use latest version instead. Returns lock-object details for selected study objects in v4.0 format. The request body contains the objects to inspect, and the response includes the matching visit, form, and item details based on the supplied mode and optional detail filters.

Request

Path Parameters

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

  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 values (optional).

  Default Value: true
• excludeItemType: string
  Exclude this form item type from response (optional).

  Allowed Values: [ "instructionalText" ]
• itemsIncluded: boolean
  Include form items in response (optional).
• mode(required): string
  Study mode (required): test, training, or active.

  Allowed Values: [ "test", "training", "active" ]
• showVisitDetails: boolean
  Include visit-level details (optional).

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object LockObjectDto V4.0
  Title: LockObjectDto V4.0

  Lock Object details

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

Nested Schema : LockObjectDto V4.0

Type: object

Title: LockObjectDto V4.0

Lock Object details

Show Source

• objectId(required): string (uuid)
  Object ID
• objectLockDate: string (date-time)
  Object Lock Date
• objectLockVersion(required): string
  Title: ObjectLockVersion

  Object lock version

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

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

  Object type

  Example: form
• parentObjectId: string (uuid)
  Parent Object ID

{
    "title":"LockObjectDto V4.0",
    "required":[
        "objectId",
        "objectLockVersion",
        "objectType"
    ],
    "type":"object",
    "properties":{
        "objectId":{
            "type":"string",
            "description":"Object ID",
            "format":"uuid"
        },
        "objectType":{
            "title":"ObjectType",
            "type":"string",
            "description":"Object type",
            "example":"form",
            "enum":[
                "form",
                "visit"
            ]
        },
        "parentObjectId":{
            "type":"string",
            "description":"Parent Object ID",
            "format":"uuid"
        },
        "objectLockVersion":{
            "title":"ObjectLockVersion",
            "type":"string",
            "description":"Object lock version",
            "example":"1.0.0.1"
        },
        "objectLockDate":{
            "type":"string",
            "description":"Object Lock Date",
            "format":"date-time"
        }
    },
    "description":"Lock Object details"
}

Examples

Select an example lockObjectRequestV4

Back to Top

Response

Supported Media Types

• application/json

200 Response

Lock object details were returned successfully.

Body ()

Root Schema : LockObjectDetailsDto v4.0

Type: object

Title: LockObjectDetailsDto v4.0

Information about all the locked objects.

Show Source

• visitObjects: object visitObjects
  Additional Properties Allowed: additionalProperties

  Locked visit object details.

{
    "title":"LockObjectDetailsDto v4.0",
    "type":"object",
    "properties":{
        "visitObjects":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "$ref":"#/components/schemas/LockObjectVersionDetailsDtoV4"
                },
                "description":"Locked visit object details."
            },
            "description":"Locked visit object details."
        }
    },
    "description":"Information about all the locked objects."
}

Nested Schema : visitObjects

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: LockObjectVersionDetailsDtoV4

  Locked visit object details.

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "$ref":"#/components/schemas/LockObjectVersionDetailsDtoV4"
        },
        "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 LockObjectVersionDetailsDtoV4
  Title: LockObjectVersionDetailsDtoV4

  Information about all the locked objects in a version

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

Locked visit object details.

Nested Schema : LockObjectVersionDetailsDtoV4

Type: object

Title: LockObjectVersionDetailsDtoV4

Information about all the locked objects in a version

Show Source

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

  Visit design.

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

Nested Schema : VisitDto v9.0

Type: object

Title: VisitDto v9.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
• 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 v9.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
        }
    },
    "description":"Visit design."
}

Examples

Select an example lockObjectResponseV4

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