Jump to

• Request
• Response

Create subject settings

post

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings

Creates a list of subject settings so that settings, such as region and country, can be dynamically created. Rights: SubjectSettingRightsPost.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study for which you want to get/update/delete subject settings.

Supported Media Types

• */*

Request Body - */* ()

Root Schema : schema

Type: object

Show Source

• subjectSettings: array subjectSettings

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

Nested Schema : subjectSettings

Type: array

Show Source

• Array of: object SubjectSetting

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

Nested Schema : SubjectSetting

Type: object

Show Source

• attributeKey: string
• attributeValue: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• userId: string (uuid)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "attributeKey":{
            "type":"string"
        },
        "attributeValue":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SubjectSetting

Type: object

Show Source

• attributeKey: string
• attributeValue: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• userId: string (uuid)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "maxLength":"16",
            "minLength":"1",
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "attributeKey":{
            "type":"string"
        },
        "attributeValue":{
            "type":"string"
        }
    }
}

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