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

Default Response

default response

Back to Top