Jump to

• Request
• Response

V1.0

put

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/safetycase/{id}

Updates the safety case status based on ID.

Request

Path Parameters

• id(required): string(uuid)
  Unique Identifire(UUID, 32-character uppercase hexadecimal string) of the safety case record being updated.

  Example:

  220ED6ED76C44CA9BC771024E5D62B2B

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  220ED6ED76C44CA9BC771024E5D62B2B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Object holds request data for Safety Case update including status, reason for status change, comment, and the external safety case identifier.

Show Source

• comment: string
  Comment for the safety case.

  Example: Follow up with site on AE form
• externalSafetyCaseId: string
  External identifier for the safety case, if available.

  Example: 12345
• reason: string
  Reason for the safety case status change.

  Example: Missing information
• status: string
  Minimum Length: 0

  Maximum Length: 100

  Status of the safety case. Value as defined as CREATED, SUBMITTED, NOT_SUBMITTED, ALL, MODIFIED, SUBMIT_FAILED, CANCEL_FAILED, REJECTED, TRANSFER_FAILED, CANCELLED, ACCEPTED,DISMISSED .

  Example: CREATED

{
    "type":"object",
    "properties":{
        "status":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Status of the safety case. Value as defined as CREATED, SUBMITTED, NOT_SUBMITTED, ALL, MODIFIED, SUBMIT_FAILED, CANCEL_FAILED, REJECTED, TRANSFER_FAILED, CANCELLED, ACCEPTED,DISMISSED .",
            "example":"CREATED"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the safety case status change.",
            "example":"Missing information"
        },
        "comment":{
            "type":"string",
            "description":"Comment for the safety case.",
            "example":"Follow up with site on AE form"
        },
        "externalSafetyCaseId":{
            "type":"string",
            "description":"External identifier for the safety case, if available.",
            "example":"12345"
        }
    },
    "description":"Object holds request data for Safety Case update including status, reason for status change, comment, and the external safety case identifier."
}

Examples

Select an example Update status of safety case.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : SafetyCasePutResponseDto

Type: object

Response object for SafetyCase update, providing status, identifiers and update information for the safety case.

Show Source

• comment: string
  Additional comments regarding the update.

  Example: No further action required
• externalSafetyCaseId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) External identifier for the safety case.

  Example: 345E4567E89B12D3A456426655440000
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) for the updated safety case.

  Example: 123E4567E89B12D3A456426655440000
• lastSubmittedDate: string (date-time)
  Last submission date/time related to the safety case.

  Example: 2023-07-10T15:30:00Z
• reason: string
  Reason for the status update.

  Example: Other
• status: string
  Status of the safety case. Value as defined as CREATED, SUBMITTED, NOT_SUBMITTED, ALL, MODIFIED, SUBMIT_FAILED, CANCEL_FAILED, REJECTED, TRANSFER_FAILED, CANCELLED, ACCEPTED,DISMISSED .

  Example: CREATED
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.0
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2023-07-01T10:20:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the updated safety case.",
            "example":"123E4567E89B12D3A456426655440000"
        },
        "externalSafetyCaseId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) External identifier for the safety case.",
            "example":"345E4567E89B12D3A456426655440000"
        },
        "status":{
            "type":"string",
            "description":"Status of the safety case. Value as defined as CREATED, SUBMITTED, NOT_SUBMITTED, ALL, MODIFIED, SUBMIT_FAILED, CANCEL_FAILED, REJECTED, TRANSFER_FAILED, CANCELLED, ACCEPTED,DISMISSED .",
            "example":"CREATED"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.0"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the status update.",
            "example":"Other"
        },
        "comment":{
            "type":"string",
            "description":"Additional comments regarding the update.",
            "example":"No further action required"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2023-07-01T10:20:30Z"
        },
        "lastSubmittedDate":{
            "type":"string",
            "description":"Last submission date/time related to the safety case.",
            "format":"date-time",
            "example":"2023-07-10T15:30:00Z"
        }
    },
    "description":"Response object for SafetyCase update, providing status, identifiers and update information for the safety case."
}

Examples

Select an example Successfully updated safety case status.

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

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

Back to Top