Jump to

• Request
• Response

V1.0

put

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unsign-unverify

Removes signature or verification from the specified set of subjects. Request body contains the set of subject IDs and optional reason and comment.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  3F2504E04F8911D39A0C0305E82C3301

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

DTO to request the unsign and/or unverify operations on one or more subjects.

Show Source

• comment: string
  Additional comments for the operation.

  Example: Investigator request for subject data change
• reason: string
  Reason for the unsign/unverify action.

  Example: Audit requirement for unsigning
• subjects(required): array subjects
  Unique Items Required: true

  List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

{
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "uniqueItems":true,
            "type":"array",
            "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
            "example":[
                "6D5E607D3E644F1DB8FFC4BCCEA48FFE",
                "2A2E107D3E644F1DB8FFC4BCCEA48ABC"
            ],
            "items":{
                "type":"string",
                "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
                "format":"uuid"
            }
        },
        "reason":{
            "type":"string",
            "description":"Reason for the unsign/unverify action.",
            "example":"Audit requirement for unsigning"
        },
        "comment":{
            "type":"string",
            "description":"Additional comments for the operation.",
            "example":"Investigator request for subject data change"
        }
    },
    "description":"DTO to request the unsign and/or unverify operations on one or more subjects.",
    "example":{
        "subjects":[
            "6D5E607D3E644F1DB8FFC4BCCEA48FFE",
            "2A2E107D3E644F1DB8FFC4BCCEA48ABC"
        ],
        "reason":"Audit requirement for unsigning",
        "comment":"Investigator request for subject data change"
    }
}

Example:

{
    "subjects":[
        "6D5E607D3E644F1DB8FFC4BCCEA48FFE",
        "2A2E107D3E644F1DB8FFC4BCCEA48ABC"
    ],
    "reason":"Audit requirement for unsigning",
    "comment":"Investigator request for subject data change"
}

Nested Schema : subjects

Type: array

Unique Items Required: true

List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

Show Source

• Array of: string(uuid)
  List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

{
    "uniqueItems":true,
    "type":"array",
    "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
    "example":[
        "6D5E607D3E644F1DB8FFC4BCCEA48FFE",
        "2A2E107D3E644F1DB8FFC4BCCEA48ABC"
    ],
    "items":{
        "type":"string",
        "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
        "format":"uuid"
    }
}

Example:

[
    "6D5E607D3E644F1DB8FFC4BCCEA48FFE",
    "2A2E107D3E644F1DB8FFC4BCCEA48ABC"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object UnsignUnverifyResponse

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

Nested Schema : UnsignUnverifyResponse

Type: object

Show Source

• subjects: string (UUID)
  List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.

  Example: ["2C3F40649C654D0F995A7FDBBCEA4FAB"]

{
    "type":"object",
    "properties":{
        "subjects":{
            "type":"string",
            "description":"List of Unique Identifier(UUID, 32-character uppercase hexadecimal string) representing Subjects.",
            "format":"UUID",
            "example":"[\"2C3F40649C654D0F995A7FDBBCEA4FAB\"]"
        }
    }
}

Examples

Select an example Unsign Unverify Success

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

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-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top