Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations/history/sourceForm/{sourceFormId}

Retrieves the audit history for a form association.

Request

Path Parameters

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

  Example:

  active

• sourceFormId(required): string(uuid)
  ID of the Source Form. The format should be UUID, 32-character uppercase hexadecimal string

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

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

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

Query Parameters

• associatedFormId: string(uuid)
  ID of the Associated Form. The format should be UUID, 32-character uppercase hexadecimal string

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

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

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

• 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

• sourceRepeatSequenceNumber: integer(int32)
  Repeat Sequence Number of Source Form. The format should be UUID, 32-character uppercase hexadecimal string

  Example:

  1

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

  Example:

  9FCBB303F8D24A3FB7DABCACF7600629

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 FormsAssociations
  Association between a source form and an associated form, including repeat and study version context

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

Nested Schema : FormsAssociations

Type: object

Association between a source form and an associated form, including repeat and study version context

Show Source

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

  Example: 5D3AA89CE2B04729A1F1C7E62D9F44B2
• 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: 8AA41F6E5D9B4F1A94E3C7B22A6610EF
• 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(required): string
  Minimum Length: 0

  Maximum Length: 100

  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.3
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment regarding the last change made to the entity.

  Example: Imported via migration tool.
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 2F3C8B1BFE784C7E86E0B29899B13E3D
• operationType: string
  Minimum Length: 1

  Maximum Length: 16

  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: REMOVED
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the entity creation or latest modification.

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

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

  Example: 5D3AA89CE2B04729A1F1C7E62D9F44B2
• 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: C41E8B2D73A54F0C9AFE22D6A1138B90
• 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: E2C77AB91F58443DB89A1D99F2F44C33
• 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(required): string
  Minimum Length: 0

  Maximum Length: 100

  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

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

  Example: A13F9C2E7B1D4F0A92CE31A4B6D9E8F1
• validationFailure: string
  Validation failure details, if any

  Example: Target form not found
• validationStatus: string
  Validation status for the association

  Example: SUCCESS

{
    "required":[
        "associatedStudyVersion",
        "srcStudyVersion"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"2F3C8B1BFE784C7E86E0B29899B13E3D"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"A13F9C2E7B1D4F0A92CE31A4B6D9E8F1"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"9B7A13D4C2F84E1AA6D2E3F9BC18A457"
        },
        "srcEventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"5D3AA89CE2B04729A1F1C7E62D9F44B2"
        },
        "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":"C41E8B2D73A54F0C9AFE22D6A1138B90"
        },
        "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":{
            "maxLength":100,
            "minLength":0,
            "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.3"
        },
        "associatedEventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"5D3AA89CE2B04729A1F1C7E62D9F44B2"
        },
        "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":"8AA41F6E5D9B4F1A94E3C7B22A6610EF"
        },
        "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":{
            "maxLength":100,
            "minLength":0,
            "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.3"
        },
        "srcItemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"E2C77AB91F58443DB89A1D99F2F44C33"
        },
        "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
        },
        "validationStatus":{
            "type":"string",
            "description":"Validation status for the association",
            "example":"SUCCESS"
        },
        "validationFailure":{
            "type":"string",
            "description":"Validation failure details, if any",
            "example":"Target form not found"
        }
    },
    "description":"Association between a source form and an associated form, including repeat and study version context"
}

Examples

Select an example FormsAssociationsHistory

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