Jump to

• Request
• Response

V2.0

put

/ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subject/{subjectId}/event/{eventId}/form/{formId}/formassociations

Updates form associations, if any, for a given form, event and subject. Deletes all associations for the data element if request is empty. The response contains additional fields like associatedFormSectionId, associatedRepeatFormNumber and srcRepeatFormNumber.

Request

Path Parameters

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

  Example:

  7FCBB303F8D24A3FB7DABCACF7600629

• formId(required): string(uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example:

  6FCBB303F8D24A3FB7DABCACF7600629

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

  Example:

  active

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

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

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

  Example:

  8FCBB303F8D24A3FB7DABCACF7600629

Query Parameters

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

  Example:

  1

• repeatFormNum: integer
  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

• repeatSequenceNum: integer
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example:

  2

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Payload to update form associations for a given form context

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment

  Example: Updated association details
• formsAssociations: array formsAssociations
  List of form association updates to apply
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason

  Example: Change for encoding

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason",
            "example":"Change for encoding"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment",
            "example":"Updated association details"
        },
        "formsAssociations":{
            "type":"array",
            "description":"List of form association updates to apply",
            "items":{
                "$ref":"#/components/schemas/FormsAssociationsDto2"
            }
        }
    },
    "description":"Payload to update form associations for a given form context"
}

Nested Schema : formsAssociations

Type: array

List of form association updates to apply

Show Source

• Array of: object FormsAssociationsDto2
  Associations between source and associated form sections including repeat numbers

{
    "type":"array",
    "description":"List of form association updates to apply",
    "items":{
        "$ref":"#/components/schemas/FormsAssociationsDto2"
    }
}

Nested Schema : FormsAssociationsDto2

Type: object

Associations between source and associated form sections including repeat numbers

Show Source

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

  Example: 0123456789ABCDEF0123456789ABCDEF
• 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: 0123456789ABCDEF0123456789ABCDEF
• associatedFormSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: 0123456789ABCDEF0123456789ABCDEF
• associatedRepeatFormNumber: integer (int64)
  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 (int64)
  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: 1.0.0.0
• comment: string
  Comment

  Example: Updated association details
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 0123456789ABCDEF0123456789ABCDEF
• objectVersionNumber: number
  Object version number used for concurrency control.

  Example: 1
• reason: string
  Reason

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

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

  Example: 0123456789ABCDEF0123456789ABCDEF
• 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: 0123456789ABCDEF0123456789ABCDEF
• srcFormSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

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

  Example: 0123456789ABCDEF0123456789ABCDEF
• srcRepeatFormNumber: integer (int64)
  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 (int64)
  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: 1.0.0.1
• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: 0123456789ABCDEF0123456789ABCDEF
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2024-12-01T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2024-12-01T10:15:30Z"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control.",
            "example":1
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "srcEventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"int64",
            "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":"1.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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"int64",
            "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":"1.0.0.0"
        },
        "reason":{
            "type":"string",
            "description":"Reason",
            "example":"Data association update"
        },
        "comment":{
            "type":"string",
            "description":"Comment",
            "example":"Updated association details"
        },
        "srcItemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "srcFormSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "associatedFormSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"int64",
            "example":1
        },
        "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":"int64",
            "example":1
        }
    },
    "description":"Associations between source and associated form sections including repeat numbers"
}

Examples

Select an example FormAssociationsUpdateDto2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormAssociationsUpdateRespDto2
  Form associations update response (v2)

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

Nested Schema : FormAssociationsUpdateRespDto2

Type: object

Form associations update response (v2)

Show Source

• formsAssociations: array formsAssociations
  List of form associations

{
    "type":"object",
    "properties":{
        "formsAssociations":{
            "type":"array",
            "description":"List of form associations",
            "items":{
                "$ref":"#/components/schemas/FormsAssociationsDto2"
            }
        }
    },
    "description":"Form associations update response (v2)"
}

Nested Schema : formsAssociations

Type: array

List of form associations

Show Source

• Array of: object FormsAssociationsDto2
  Associations between source and associated form sections including repeat numbers

{
    "type":"array",
    "description":"List of form associations",
    "items":{
        "$ref":"#/components/schemas/FormsAssociationsDto2"
    }
}

Nested Schema : FormsAssociationsDto2

Type: object

Associations between source and associated form sections including repeat numbers

Show Source

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

  Example: 0123456789ABCDEF0123456789ABCDEF
• 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: 0123456789ABCDEF0123456789ABCDEF
• associatedFormSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

  Example: 0123456789ABCDEF0123456789ABCDEF
• associatedRepeatFormNumber: integer (int64)
  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 (int64)
  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: 1.0.0.0
• comment: string
  Comment

  Example: Updated association details
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 0123456789ABCDEF0123456789ABCDEF
• objectVersionNumber: number
  Object version number used for concurrency control.

  Example: 1
• reason: string
  Reason

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

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

  Example: 0123456789ABCDEF0123456789ABCDEF
• 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: 0123456789ABCDEF0123456789ABCDEF
• srcFormSectionId: string
  ID (UUID, 32-character uppercase hexadecimal string) of the form section.

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

  Example: 0123456789ABCDEF0123456789ABCDEF
• srcRepeatFormNumber: integer (int64)
  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 (int64)
  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: 1.0.0.1
• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: 0123456789ABCDEF0123456789ABCDEF
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2024-12-01T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2024-12-01T10:15:30Z"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control.",
            "example":1
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "srcEventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"int64",
            "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":"1.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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"int64",
            "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":"1.0.0.0"
        },
        "reason":{
            "type":"string",
            "description":"Reason",
            "example":"Data association update"
        },
        "comment":{
            "type":"string",
            "description":"Comment",
            "example":"Updated association details"
        },
        "srcItemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "srcFormSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "associatedFormSectionId":{
            "type":"string",
            "description":"ID (UUID, 32-character uppercase hexadecimal string) of the form section.",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "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":"int64",
            "example":1
        },
        "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":"int64",
            "example":1
        }
    },
    "description":"Associations between source and associated form sections including repeat numbers"
}

Examples

Select an example FormAssociationsUpdateRespV2

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

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