Jump to

• Request
• Response

Create a resupply strategy

post

/ec-ors-svc/rest/v2.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

Request Body - 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."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top