Jump to

• Request
• Response

V1.0

post

/ec-designer-svc/rest/v1.0/studies/{studyId}/studyObjectsMapping

Returns study object mappings from source study to target study.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

  Example:

  F054C951EB74443C93716CA714AB686E

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• fromEventIds: array fromEventIds
• fromFormIds: array fromFormIds
• fromStudyVersion: string
  Source study version.

  Example: 1.0
• toStudyId: string (uuid)
  Target study GUID.
• toStudyVersion: string
  Target study version.

  Example: 2.0

{
    "type":"object",
    "properties":{
        "fromStudyVersion":{
            "type":"string",
            "description":"Source study version.",
            "example":"1.0"
        },
        "toStudyId":{
            "type":"string",
            "description":"Target study GUID.",
            "format":"uuid"
        },
        "toStudyVersion":{
            "type":"string",
            "description":"Target study version.",
            "example":"2.0"
        },
        "fromFormIds":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Source form GUID.",
                "format":"uuid"
            }
        },
        "fromEventIds":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Source visit/event GUID.",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : fromEventIds

Type: array

Show Source

• Array of: string(uuid)
  Source visit/event GUID.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Source visit/event GUID.",
        "format":"uuid"
    }
}

Nested Schema : fromFormIds

Type: array

Show Source

• Array of: string(uuid)
  Source form GUID.

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Source form GUID.",
        "format":"uuid"
    }
}

Examples

Select an example requestExample

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : RespStudyObjectsFormsDto

Type: object

Show Source

• forms: array forms
• visits: array visits

{
    "type":"object",
    "properties":{
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyObjectsFormDtoV1"
            }
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyObjectsVisitDtoV1"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object StudyObjectsFormDto v1.0
  Title: StudyObjectsFormDto v1.0

  Form mapping between source and target studies.

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

Nested Schema : visits

Type: array

Show Source

• Array of: object StudyObjectsVisitDto v1.0
  Title: StudyObjectsVisitDto v1.0

  Visit mapping between source and target studies.

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

Nested Schema : StudyObjectsFormDto v1.0

Type: object

Title: StudyObjectsFormDto v1.0

Form mapping between source and target studies.

Show Source

• fromFormId: string (uuid)
  Source form GUID.
• fromFormRefName: string
  Source form reference name.

  Example: FORM_DEMOGRAPHY
• items: array items
• toFormId: string (uuid)
  Target form GUID.
• toFormRefName: string
  Target form reference name.

  Example: FORM_DEMOGRAPHY_COPY
• visits: array visits

{
    "title":"StudyObjectsFormDto v1.0",
    "type":"object",
    "properties":{
        "fromFormId":{
            "type":"string",
            "description":"Source form GUID.",
            "format":"uuid"
        },
        "fromFormRefName":{
            "type":"string",
            "description":"Source form reference name.",
            "example":"FORM_DEMOGRAPHY"
        },
        "toFormId":{
            "type":"string",
            "description":"Target form GUID.",
            "format":"uuid"
        },
        "toFormRefName":{
            "type":"string",
            "description":"Target form reference name.",
            "example":"FORM_DEMOGRAPHY_COPY"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyObjectsItemDtoV1"
            }
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyObjectsVisitDtoV1"
            }
        }
    },
    "description":"Form mapping between source and target studies."
}

Nested Schema : items

Type: array

Show Source

• Array of: object StudyObjectsItemDto v1.0
  Title: StudyObjectsItemDto v1.0

  Form item mapping between source and target studies.

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

Nested Schema : visits

Type: array

Show Source

• Array of: object StudyObjectsVisitDto v1.0
  Title: StudyObjectsVisitDto v1.0

  Visit mapping between source and target studies.

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

Nested Schema : StudyObjectsItemDto v1.0

Type: object

Title: StudyObjectsItemDto v1.0

Form item mapping between source and target studies.

Show Source

• fromItemId: string (uuid)
  Source item GUID.
• fromItemRefName: string
  Source item reference name.

  Example: ITEM_AGE
• toItemId: string (uuid)
  Target item GUID.
• toItemRefName: string
  Target item reference name.

  Example: ITEM_AGE_COPY

{
    "title":"StudyObjectsItemDto v1.0",
    "type":"object",
    "properties":{
        "fromItemId":{
            "type":"string",
            "description":"Source item GUID.",
            "format":"uuid"
        },
        "fromItemRefName":{
            "type":"string",
            "description":"Source item reference name.",
            "example":"ITEM_AGE"
        },
        "toItemId":{
            "type":"string",
            "description":"Target item GUID.",
            "format":"uuid"
        },
        "toItemRefName":{
            "type":"string",
            "description":"Target item reference name.",
            "example":"ITEM_AGE_COPY"
        }
    },
    "description":"Form item mapping between source and target studies."
}

Nested Schema : StudyObjectsVisitDto v1.0

Type: object

Title: StudyObjectsVisitDto v1.0

Visit mapping between source and target studies.

Show Source

• fromVisitId: string (uuid)
  Source visit GUID.
• fromVisitRefName: string
  Source visit reference name.

  Example: SCREENING
• toVisitId: string (uuid)
  Target visit GUID.
• toVisitRefName: string
  Target visit reference name.

  Example: SCREENING_COPY

{
    "title":"StudyObjectsVisitDto v1.0",
    "type":"object",
    "properties":{
        "fromVisitId":{
            "type":"string",
            "description":"Source visit GUID.",
            "format":"uuid"
        },
        "fromVisitRefName":{
            "type":"string",
            "description":"Source visit reference name.",
            "example":"SCREENING"
        },
        "toVisitId":{
            "type":"string",
            "description":"Target visit GUID.",
            "format":"uuid"
        },
        "toVisitRefName":{
            "type":"string",
            "description":"Target visit reference name.",
            "example":"SCREENING_COPY"
        }
    },
    "description":"Visit mapping between source and target studies."
}

Examples

Select an example successResponse

500 Response

Returned when the request cannot be completed due to validation failure, authorization failure, or an unexpected server-side condition.

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Back to Top