Jump to

• Request
• Response

Lock multiple visits' items

post

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/visits/lock

This API locks multiple items from multiple visits.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectVisitsFormsItemsDTO

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

Nested Schema : SubjectVisitsFormsItemsDTO

Type: object

Show Source

• events: array events
• subjectId: string (uuid)

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitFormsItemsDTO"
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

• Array of: object VisitFormsItemsDTO

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

Nested Schema : VisitFormsItemsDTO

Type: object

Show Source

• elements: array elements
• eventId: string (uuid)
• eventInstanceNum: integer
• studyVersion: string

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "studyVersion":{
            "type":"string"
        },
        "elements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataElementRequestDTO"
            }
        }
    }
}

Nested Schema : elements

Type: array

Show Source

• Array of: object DataElementRequestDTO

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

Nested Schema : DataElementRequestDTO

Type: object

Show Source

• formId: string (uuid)
• formSectionId: string (uuid)
• innerRepeat: integer
• itemId: string (uuid)
• outerRepeat: integer

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectVisitsItemsResponseDTO

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

Nested Schema : SubjectVisitsItemsResponseDTO

Type: object

Show Source

• exceptions: array exceptions
• failedObjects: array failedObjects
• processedObjects: array processedObjects

{
    "type":"object",
    "properties":{
        "processedObjects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectVisitsFormsItemsDTO"
            }
        },
        "failedObjects":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectVisitsFormsItemsDTO"
            }
        },
        "exceptions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : exceptions

Type: array

Show Source

• Array of: string

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

Nested Schema : failedObjects

Type: array

Show Source

• Array of: object SubjectVisitsFormsItemsDTO

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

Nested Schema : processedObjects

Type: array

Show Source

• Array of: object SubjectVisitsFormsItemsDTO

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

Nested Schema : SubjectVisitsFormsItemsDTO

Type: object

Show Source

• events: array events
• subjectId: string (uuid)

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitFormsItemsDTO"
            }
        }
    }
}

Nested Schema : events

Type: array

Show Source

• Array of: object VisitFormsItemsDTO

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

Nested Schema : VisitFormsItemsDTO

Type: object

Show Source

• elements: array elements
• eventId: string (uuid)
• eventInstanceNum: integer
• studyVersion: string

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "studyVersion":{
            "type":"string"
        },
        "elements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataElementRequestDTO"
            }
        }
    }
}

Nested Schema : elements

Type: array

Show Source

• Array of: object DataElementRequestDTO

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

Nested Schema : DataElementRequestDTO

Type: object

Show Source

• formId: string (uuid)
• formSectionId: string (uuid)
• innerRepeat: integer
• itemId: string (uuid)
• outerRepeat: integer

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "itemId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

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