Update a resupply by ID
put
/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Updates a resupply group by ID. Rights: SupplySettingRightsPost. Required sponsor roles are clinical supply manager and site manager.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
resupplyId(required): string(uuid)
ID of resupply group
-
studyId(required): string(uuid)
ID of the study
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Request object for resupply group.
Show Source
-
kitTypes(required): array
kitTypes
Minimum Number of Items:
1
Maximum Number of Items:2147483647
-
resupplyId: string
(uuid)
Resupply Id
-
resupplyName(required): string
Minimum Length:
0
Maximum Length:50
Resupply nameExample:Resupply 1
-
resupplyTypeId(required): integer
(int32)
Id of the resupply type.Example:
2
-
type(required): string
Nested Schema : kitTypes
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
2147483647
-
Array of:
object ResupplyGroupRequest.KitTypeSummary
Kit type summary details object.
Nested Schema : ResupplyGroupRequest.KitTypeSummary
Type:
object
Kit type summary details object.
Show Source
-
id(required): string
ID of the kit type.Example:
kitA
-
initialShippingUnits: number
(double)
Minimum Value:
0
Maximum Value:99
The number of kits of each type that are in the initial shipment.Example:50
-
manualConsignment: number
(double)
Minimum Value:
0
Maximum Value:99
The number of kits of each type that are included in a manual shipment.Example:50
-
maxBuffer(required): number
(double)
Minimum Value:
0
The number of kits that will be present at the site after a resupply shipment arrives.Example:50
-
minBuffer(required): number
(double)
Minimum Value:
0
The number of kits that trigger a shipment when the resupply strategy runs.Example:5
-
resupplyWeeks: number
(double)
Minimum Value:
0
Maximum Value:99
The number of weeks that the resupply strategy resupplies for.Example:3
-
triggerWeeks: number
(double)
Minimum Value:
0
Maximum Value:99
The number of weeks that the resupply strategy looks out to determine the supply.Example:3
Response
Supported Media Types
- application/json
200 Response
Successful operation
400 Response
'Validation error, 'Invalid resupply type', 'Resupply already exists', 'Resupply contains duplicate IDs for kit types', 'Invalid kit type'
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
'Resupply not found', 'Study identifier does not match any study identifiers in Clinical One.'
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Internal server error
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object