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:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource
500 Response
Error
Root Schema : ErrorResponseData
Type:
objectStructure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
-
details: string
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.Example:
User role is missing required permission REPORTING_VIEW. Field: userId -
errorCode: string
Application or business-specific error code representing the error type.Example:
REPT_401 -
errorMessage: string
Human-readable error message describing the failure or issue.Example:
Unauthorized: User does not have access to the requested resource