REST API for Clinical One Platform

Get list of roles for a study

get

/ec-auth-svc/rest/v3.0/authroles/{studyId}

Retrieves the list of study roles for a specific role type.

Request

Path Parameters

studyId(required): string(uuid)

Study ID

Query Parameters

studyRoleType(required): string

Study role type

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object DisplayRoleDtoV2

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

Nested Schema : DisplayRoleDtoV2

Type: object

Show Source

id(required): string (uuid)
objectVersionNumber(required): number
roleCategory(required): string
roleName(required): string
roleSubCategory: string
roleType(required): string
unblinded: string

{
    "required":[
        "id",
        "objectVersionNumber",
        "roleCategory",
        "roleName",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "roleType":{
            "type":"string"
        },
        "roleCategory":{
            "type":"string"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "unblinded":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        }
    }
}

400 Response

Bad request

Root Schema : Response

Type: object

Show Source

allowedMethods: array allowedMethods

Unique Items Required: true
closed: boolean
cookies: object cookies

Additional Properties Allowed: NewCookie
date: string (date-time)
entity: object entity
entityTag: object EntityTag
headers: object headers

Additional Properties Allowed: additionalProperties
language: object language
lastModified: string (date-time)
length: integer (int32)
links: array links

Unique Items Required: true
location: string (uri)
mediaType: object MediaType
metadata: object metadata

Additional Properties Allowed: additionalProperties
status: integer (int32)
statusInfo: object StatusType
stringHeaders: object stringHeaders

Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "location":{
            "type":"string",
            "format":"uri"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                }
            }
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "closed":{
            "type":"boolean"
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "statusInfo":{
            "$ref":"#/components/schemas/StatusType"
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/NewCookie"
            }
        },
        "entityTag":{
            "$ref":"#/components/schemas/EntityTag"
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : allowedMethods

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : cookies

Type: object

Additional Properties Allowed

Show Source

object NewCookie

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/NewCookie"
    }
}

Nested Schema : entity

Type: object

Nested Schema : EntityTag

Type: object

Show Source

value: string
weak: boolean

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "weak":{
            "type":"boolean"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : language

Type: object

Show Source

country: string
displayCountry: string
displayLanguage: string
displayName: string
displayScript: string
displayVariant: string
extensionKeys: array extensionKeys

Unique Items Required: true
iso3Country: string
iso3Language: string
language: string
script: string
unicodeLocaleAttributes: array unicodeLocaleAttributes

Unique Items Required: true
unicodeLocaleKeys: array unicodeLocaleKeys

Unique Items Required: true
variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

Array of: object Link

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : MediaType

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
subtype: string
type: string
wildcardSubtype: boolean
wildcardType: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean"
        },
        "wildcardSubtype":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : StatusType

Type: object

Show Source

family: string

Allowed Values: [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
reasonPhrase: string
statusCode: integer (int32)

{
    "type":"object",
    "properties":{
        "family":{
            "type":"string",
            "enum":[
                "INFORMATIONAL",
                "SUCCESSFUL",
                "REDIRECTION",
                "CLIENT_ERROR",
                "SERVER_ERROR",
                "OTHER"
            ]
        },
        "reasonPhrase":{
            "type":"string"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : stringHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : NewCookie

Type: object

Show Source

comment: string
domain: string
expiry: string (date-time)
httpOnly: boolean
maxAge: integer (int32)
name: string
path: string
sameSite: string

Allowed Values: [ "NONE", "LAX", "STRICT" ]
secure: boolean
value: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "path":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "maxAge":{
            "type":"integer",
            "format":"int32"
        },
        "expiry":{
            "type":"string",
            "format":"date-time"
        },
        "secure":{
            "type":"boolean"
        },
        "httpOnly":{
            "type":"boolean"
        },
        "sameSite":{
            "type":"string",
            "enum":[
                "NONE",
                "LAX",
                "STRICT"
            ]
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Show Source

params: object params

Additional Properties Allowed: additionalProperties
rel: string
rels: array rels
title: string
type: string
uri: string (uri)
uriBuilder: object UriBuilder

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "title":{
            "type":"string"
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "uriBuilder":{
            "$ref":"#/components/schemas/UriBuilder"
        },
        "rel":{
            "type":"string"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : rels

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : UriBuilder

Type: object

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}