Get study identity based on protocol ID
get
/ec-designer-svc/rest/v1.0/studies/identity
Retrieves a study's identity based on protocol ID.
Request
Query Parameters
-
protocolId: string
Study protocol idDefault Value:
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : StudyIdentityDto
Type:
Show Source
object
-
id: string
(uuid)
Study Id
-
protocolDescription: string
Study protocol description
-
protocolNumber: string
Study protocol number
404 Response
Error
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-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.
500 Response
Error
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-003Example:
C1-003
-
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : Object
Type:
object
Title:
Object
Object with error details information.