Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers/randstatus/bulk

Accepts an asynchronous bulk randomization-number status update. Rights: OrsRandListPost and OrsUnblinded.

Request

Path Parameters

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

  Example:

  test

• rndlistid(required): string(uuid)
  ID of the randomization list.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

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

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request to asynchronously update randomization-number statuses in bulk.

Show Source

• filters: object BulkRandNumberSelectionCriteria
  Filters used to select randomization numbers for a bulk status update.
• randNumberIds: array randNumberIds
  Explicit randomization number IDs to update. Provide either randNumberIds or filters, not both.
• reason(required): string
  Reason for the bulk status update.

  Example: Correction requested before randomization.
• requestedCount(required): integer (int32)
  Minimum Value: 1

  Number of randomization numbers expected to be updated.

  Example: 10
• toStatusId(required): integer (int32)
  Allowed Values: [ 1, 2, 3 ]

  Target randomization status ID.

  Example: 2

{
    "required":[
        "reason",
        "requestedCount",
        "toStatusId"
    ],
    "type":"object",
    "properties":{
        "randNumberIds":{
            "type":"array",
            "description":"Explicit randomization number IDs to update. Provide either randNumberIds or filters, not both.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "filters":{
            "$ref":"#/components/schemas/BulkRandNumberSelectionCriteria"
        },
        "requestedCount":{
            "minimum":1,
            "type":"integer",
            "description":"Number of randomization numbers expected to be updated.",
            "format":"int32",
            "example":10
        },
        "toStatusId":{
            "type":"integer",
            "description":"Target randomization status ID.",
            "format":"int32",
            "example":2,
            "enum":[
                1,
                2,
                3
            ]
        },
        "reason":{
            "type":"string",
            "description":"Reason for the bulk status update.",
            "example":"Correction requested before randomization."
        }
    },
    "description":"Request to asynchronously update randomization-number statuses in bulk."
}

Nested Schema : BulkRandNumberSelectionCriteria

Type: object

Filters used to select randomization numbers for a bulk status update.

Show Source

• blockedBy: string (uuid)
  Blocking parameter source ID used to filter randomization numbers.
• cohortId: string
  Cohort source ID to filter by.

  Example: D313327EF13845169A8ADADDA435431E
• searchString: string
  Search text matched against randomization number or subject number.

  Example: S1001
• status: number
  Allowed Values: [ 1, 2, 3 ]

  Current randomization status ID to filter by.

  Example: 2
• treatmentSrcId: string (uuid)
  Treatment arm source ID to filter by. Not supported for minimization randomization lists.

{
    "type":"object",
    "properties":{
        "searchString":{
            "type":"string",
            "description":"Search text matched against randomization number or subject number.",
            "example":"S1001"
        },
        "blockedBy":{
            "type":"string",
            "description":"Blocking parameter source ID used to filter randomization numbers.",
            "format":"uuid"
        },
        "status":{
            "type":"number",
            "description":"Current randomization status ID to filter by.",
            "example":2,
            "enum":[
                1,
                2,
                3
            ]
        },
        "cohortId":{
            "type":"string",
            "description":"Cohort source ID to filter by.",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "treatmentSrcId":{
            "type":"string",
            "description":"Treatment arm source ID to filter by. Not supported for minimization randomization lists.",
            "format":"uuid"
        }
    },
    "description":"Filters used to select randomization numbers for a bulk status update."
}

Nested Schema : randNumberIds

Type: array

Explicit randomization number IDs to update. Provide either randNumberIds or filters, not both.

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "description":"Explicit randomization number IDs to update. Provide either randNumberIds or filters, not both.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Select an example Bulk Randomization Status Update Request Bulk Randomization Status Update Explicit Selection Request

Back to Top

Response

Supported Media Types

• application/json

202 Response

Successful operation

Body ()

Root Schema : BulkRandNumberStatusUpdateResponse

Type: object

Response returned after a bulk randomization status update request is accepted.

Show Source

• jobId: string (uuid)
  Identifier for the accepted bulk status update job.
• message: string
  Message describing the accepted request.

  Example: Update will trigger email notification upon completion.

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Identifier for the accepted bulk status update job.",
            "format":"uuid"
        },
        "message":{
            "type":"string",
            "description":"Message describing the accepted request.",
            "example":"Update will trigger email notification upon completion."
        }
    },
    "description":"Response returned after a bulk randomization status update request is accepted."
}

Examples

Select an example Bulk Randomization Status Update Accepted Response

400 Response

Bad request.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example Bulk Randomization Status Update Bad Request Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example Bulk Randomization Status Update Server Error Response

Back to Top