REST API for Clinical One Cloud Service

V7.0

post

/ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/repeatSection/consolidatedRepeatInstanceNumbers

Returns list of repeat form numbers, form section IDs and repeat instance numbers that belong to a given subject, visit and formIds.

Request

Path Parameters

studyId(required): string(UUID)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
ABCDEF1234567890ABCDEF1234567890
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Request to compute consolidated repeat instance numbers across multiple forms for a subject

Show Source

forms: array forms

List of form IDs for which consolidated repeat instance numbers are requested
subjectId: string

Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: ABCDEF1234567890ABCDEF1234567890

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "forms":{
            "type":"array",
            "description":"List of form IDs for which consolidated repeat instance numbers are requested",
            "example":[
                "40DB4EF4847849CCB24EFCCB71CDA436",
                "50DB4EF4847849CCB24EFCCB71CDA436"
            ],
            "items":{
                "type":"string",
                "description":"List of form IDs for which consolidated repeat instance numbers are requested",
                "example":"[\"40DB4EF4847849CCB24EFCCB71CDA436\",\"50DB4EF4847849CCB24EFCCB71CDA436\"]"
            }
        }
    },
    "description":"Request to compute consolidated repeat instance numbers across multiple forms for a subject"
}

Nested Schema : forms

Type: array

List of form IDs for which consolidated repeat instance numbers are requested

Show Source

Array of: string

List of form IDs for which consolidated repeat instance numbers are requested

Example: ["40DB4EF4847849CCB24EFCCB71CDA436","50DB4EF4847849CCB24EFCCB71CDA436"]

{
    "type":"array",
    "description":"List of form IDs for which consolidated repeat instance numbers are requested",
    "example":[
        "40DB4EF4847849CCB24EFCCB71CDA436",
        "50DB4EF4847849CCB24EFCCB71CDA436"
    ],
    "items":{
        "type":"string",
        "description":"List of form IDs for which consolidated repeat instance numbers are requested",
        "example":"[\"40DB4EF4847849CCB24EFCCB71CDA436\",\"50DB4EF4847849CCB24EFCCB71CDA436\"]"
    }
}

Example:

[
    "40DB4EF4847849CCB24EFCCB71CDA436",
    "50DB4EF4847849CCB24EFCCB71CDA436"
]

Examples

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ConsolidatedRepeatInstanceResponseDto

Consolidated repeat instance numbers per form and event.

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

Nested Schema : ConsolidatedRepeatInstanceResponseDto

Type: object

Consolidated repeat instance numbers per form and event.

Show Source

eventId: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: CBCDEF1234567890ABCDEF1234567890
eventInstanceNumber: integer (int32)

Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

Example: 1
formId: string (UUID)

Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

Example: 40DB4EF4847849CCB24EFCCB71CDA436
instances: array instances

Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

{
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"CBCDEF1234567890ABCDEF1234567890"
        },
        "eventInstanceNumber":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "instances":{
            "type":"array",
            "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
            "example":[
                "1",
                "2"
            ],
            "items":{
                "type":"string",
                "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
                "example":"[\"1\",\"2\"]"
            }
        }
    },
    "description":"Consolidated repeat instance numbers per form and event."
}

Nested Schema : instances

Type: array

Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

Show Source

Array of: string

Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

Example: ["1","2"]

{
    "type":"array",
    "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
    "example":[
        "1",
        "2"
    ],
    "items":{
        "type":"string",
        "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
        "example":"[\"1\",\"2\"]"
    }
}

Example:

[
    "1",
    "2"
]

Examples

400 Response

Bad request.

Root Schema : DcsResponse

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