Jump to

• Request
• Response

v1.0

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/formassociations

This API retrieves a list of form associations for a given study, filtered by parameters such as subject ID, event ID, and event instance number. The response includes a paginated list of form associations, containing details about the source and associated forms, events, and subjects.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  active

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  ABCDEF1234567890ABCDEF1234567890

Query Parameters

• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example:

  ADF5A7800A954FA5B831E7B6B9CA39A9

• eventInstanceNum: integer(int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example:

  1

• limit: integer(int32)
  limit

  Example:

  25

• offset: integer(int32)
  offset

  Example:

  0

• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  10F75668189F422F9A461A315D211111

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 FormsAssociationsHistoryDto2
  Extends FormsAssociationsHistoryDto with version end timestamp, software version number and section linkage details for source and associated forms including repeat form numbers.

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

Nested Schema : FormsAssociationsHistoryDto2

Type: object

Extends FormsAssociationsHistoryDto with version end timestamp, software version number and section linkage details for source and associated forms including repeat form numbers.

Show Source

• associatedEventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: 93CC828113AC439181071CB44D2C6FE5
• associatedEventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• associatedFormId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: AA11BB22CC33DD44EE55FF6677889900
• associatedFormSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: C6E0C7D5A1F3428C8B8B6A77C5E9D4AB
• associatedRepeatFormNumber: integer (int32)
  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
• associatedRepeatSequenceNumber: integer (int32)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1
• associatedStudyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 3.0.0.2
• comment: string
  Comment

  Example: Linked forms across events
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the association record

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• objectVersionNumber: number
  Object version number used for concurrency control.

  Example: 14
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: CREATED
• reason: string
  Reason

  Example: Association created
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: ABCDEF1234567890ABCDEF1234567890
• softwareVersionNumber: number
  Software version number

  Example: 14
• srcEventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: ADF5A7800A954FA5B831E7B6B9CA39A9
• srcEventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example: 1
• srcFormId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• srcFormSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
• srcItemId: string
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
• srcRepeatFormNumber: integer (int32)
  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
• srcRepeatSequenceNumber: integer (int32)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1
• srcStudyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: ABCDEF1234567890ABCDEF1234567890
• userId: string
  User identifier (UUID) who created or modified the association

  Example: 9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D
• versionEnd: string (date-time)
  The end date until which the data is applicable or valid.

  Example: 2023-01-01T10:00:00Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2023-01-01T09:00:00Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the association record",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control.",
            "example":14
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "srcEventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "srcEventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "srcFormId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "srcRepeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int32",
            "example":1
        },
        "srcStudyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "associatedEventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"93CC828113AC439181071CB44D2C6FE5"
        },
        "associatedEventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "associatedFormId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"AA11BB22CC33DD44EE55FF6677889900"
        },
        "associatedRepeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int32",
            "example":1
        },
        "associatedStudyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"3.0.0.2"
        },
        "reason":{
            "type":"string",
            "description":"Reason",
            "example":"Association created"
        },
        "comment":{
            "type":"string",
            "description":"Comment",
            "example":"Linked forms across events"
        },
        "srcItemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"CREATED"
        },
        "userId":{
            "type":"string",
            "description":"User identifier (UUID) who created or modified the association",
            "example":"9F8E7D6C5B4A3A2B1C0D9E8F7A6B5C4D"
        },
        "versionEnd":{
            "type":"string",
            "description":"The end date until which the data is applicable or valid.",
            "format":"date-time",
            "example":"2023-01-01T10:00:00Z"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "example":14
        },
        "srcFormSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA"
        },
        "associatedFormSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"C6E0C7D5A1F3428C8B8B6A77C5E9D4AB"
        },
        "srcRepeatFormNumber":{
            "type":"integer",
            "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.",
            "format":"int32",
            "example":1
        },
        "associatedRepeatFormNumber":{
            "type":"integer",
            "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.",
            "format":"int32",
            "example":1
        }
    },
    "description":"Extends FormsAssociationsHistoryDto with version end timestamp, software version number and section linkage details for source and associated forms including repeat form numbers."
}

Examples

Select an example PaginatedFormsAssociationsHistoryDto2List

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top