REST API for Clinical One Platform

Create a async resupply strategy

post

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupply/resupply

Creates a resupply strategy for a study. Rights: OrsSupplyManagerPost. If the Resupply type is Predictive for any site and Trigger weeks and Resupply weeks aren't defined for any resupplykit type, a configuration exception is thrown. If Min/Max buffers aren't defined, the resupply strategy would use 0for the buffers. No exception is thrown.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

Supported Media Types

application/json

Root Schema : schema

Type: object

Resupply request object.

Show Source

jobInstanceId: string

Job instance Id.

Example: 4FEBE3E166454E2687C6FAC306E7C86E

{
    "type":"object",
    "properties":{
        "jobInstanceId":{
            "type":"string",
            "description":"Job instance Id.",
            "example":"4FEBE3E166454E2687C6FAC306E7C86E"
        }
    },
    "description":"Resupply request object."
}

Response

Supported Media Types

application/json

202 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object ResupplyResponse

Response object containing resupply details.

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

Nested Schema : ResupplyResponse

Type: object

Response object containing resupply details.

Show Source

orderId: string (uuid)

Order Id
status: string

Allowed Values: [ "PENDING", "INTRANSIT", "RECEIVED", "CANCELLED", "LOST", "CONFIRMED", "INVALID", "PENDING_DESTRUCTION", "RECEIVED_FOR_DESTRUCTION", "DESTROYED" ]

Order status.

Example: DESTROYED

{
    "type":"object",
    "properties":{
        "orderId":{
            "type":"string",
            "description":"Order Id",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"Order status.",
            "example":"DESTROYED",
            "enum":[
                "PENDING",
                "INTRANSIT",
                "RECEIVED",
                "CANCELLED",
                "LOST",
                "CONFIRMED",
                "INVALID",
                "PENDING_DESTRUCTION",
                "RECEIVED_FOR_DESTRUCTION",
                "DESTROYED"
            ]
        }
    },
    "description":"Response object containing resupply details."
}

404 Response

Not found

Root 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: 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

{
    "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":"string",
            "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."
}

500 Response

Internal server error

Root 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: 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

{
    "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":"string",
            "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."
}