Jump to

• Request
• Response

Update multiple data elements for a given form, event and subject

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.

Request

Path Parameters

• eventId(required): string
  ID of the visit for which you want to update the forms associations.
• formId(required): string
  ID of the form for which you want to update the forms associations.
• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study
• subjectId(required): string
  ID of the subject for whom you want to update the forms associations.

Query Parameters

• eventInstanceNum: integer
  Instance of the visit for which you want to update the forms associations.
• repeatFormNum: integer
  Repeat form number of the visit for which you want to update the forms associations.
• repeatSequenceNum: integer
  Repeat sequence number of the visit for which you want to update the forms associations.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• formsAssociations: array formsAssociations
• reason: string
  Minimum Length: 0

  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "formsAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormsAssociationsDto2"
            }
        }
    }
}

Nested Schema : formsAssociations

Type: array

Show Source

• Array of: object FormsAssociationsDto2

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

Nested Schema : FormsAssociationsDto2

Type: object

Show Source

• associatedEventId: string
• associatedEventInstanceNum: integer (int32)
• associatedFormId: string
• associatedFormSectionId: string
• associatedRepeatFormNumber: integer
• associatedRepeatSequenceNumber: integer
• associatedStudyVersion: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• reason: string
• siteId: string
• srcEventId: string
• srcEventInstanceNum: integer (int32)
• srcFormId: string
• srcFormSectionId: string
• srcItemId: string
• srcRepeatFormNumber: integer
• srcRepeatSequenceNumber: integer
• srcStudyVersion: string
• subjectId: string
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "subjectId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "srcEventId":{
            "type":"string"
        },
        "srcEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "srcFormId":{
            "type":"string"
        },
        "srcRepeatSequenceNumber":{
            "type":"integer"
        },
        "srcStudyVersion":{
            "type":"string"
        },
        "associatedEventId":{
            "type":"string"
        },
        "associatedEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedFormId":{
            "type":"string"
        },
        "associatedRepeatSequenceNumber":{
            "type":"integer"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "srcItemId":{
            "type":"string"
        },
        "srcFormSectionId":{
            "type":"string"
        },
        "associatedFormSectionId":{
            "type":"string"
        },
        "associatedRepeatFormNumber":{
            "type":"integer"
        },
        "srcRepeatFormNumber":{
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormAssociationsUpdateRespDto2

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

Nested Schema : FormAssociationsUpdateRespDto2

Type: object

Show Source

• formsAssociations: array formsAssociations

{
    "type":"object",
    "properties":{
        "formsAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormsAssociationsDto2"
            }
        }
    }
}

Nested Schema : formsAssociations

Type: array

Show Source

• Array of: object FormsAssociationsDto2

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

Nested Schema : FormsAssociationsDto2

Type: object

Show Source

• associatedEventId: string
• associatedEventInstanceNum: integer (int32)
• associatedFormId: string
• associatedFormSectionId: string
• associatedRepeatFormNumber: integer
• associatedRepeatSequenceNumber: integer
• associatedStudyVersion: string
• comment: string
• id: string (uuid)
• objectVersionNumber: number
• reason: string
• siteId: string
• srcEventId: string
• srcEventInstanceNum: integer (int32)
• srcFormId: string
• srcFormSectionId: string
• srcItemId: string
• srcRepeatFormNumber: integer
• srcRepeatSequenceNumber: integer
• srcStudyVersion: string
• subjectId: string
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "subjectId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "srcEventId":{
            "type":"string"
        },
        "srcEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "srcFormId":{
            "type":"string"
        },
        "srcRepeatSequenceNumber":{
            "type":"integer"
        },
        "srcStudyVersion":{
            "type":"string"
        },
        "associatedEventId":{
            "type":"string"
        },
        "associatedEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedFormId":{
            "type":"string"
        },
        "associatedRepeatSequenceNumber":{
            "type":"integer"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "srcItemId":{
            "type":"string"
        },
        "srcFormSectionId":{
            "type":"string"
        },
        "associatedFormSectionId":{
            "type":"string"
        },
        "associatedRepeatFormNumber":{
            "type":"integer"
        },
        "srcRepeatFormNumber":{
            "type":"integer"
        }
    }
}

400 Response

Bad request.

Body ()

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

Back to Top