REST API for Clinical One Platform

Update multiple non-serialized kits

put

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory

Updates inventory status, location or label of multiple non-serialized kits.

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

Root Schema : schema

Type: object

Show Source

inventoryStatusId: number (Integer)

Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]

Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

Example: 10
kitFilters: object NsKitFilters
kits: array kits
labelGroupId: string

Label group id

Example: 30100000200000000000000000000005
location: string

Location

Example: 30100000200000000000000000000005
objectVersionNumber: number
quantity(required): number

Minimum Value: 1

Quantity of kits in a lot

Example: 15
reason: string

Minimum Length: 0

Maximum Length: 255

Reason of update

Example: new kits are available

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "inventoryStatusId":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"Integer",
            "example":"10",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group id",
            "example":"30100000200000000000000000000005"
        },
        "location":{
            "type":"string",
            "description":"Location",
            "example":"30100000200000000000000000000005"
        },
        "quantity":{
            "minimum":"1",
            "type":"number",
            "description":"Quantity of kits in a lot",
            "example":"15"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"Reason of update",
            "example":"new kits are available"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "kitFilters":{
            "$ref":"#/components/schemas/NsKitFilters"
        },
        "kits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : NsKitFilters

Type: object

Show Source

Kit Status: number (Integer)

Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]

Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

Example: 10
kit type Ids(required): array kit type Ids

kit type selected.
labelGroupId: string

Label group id

Example: 30100000200000000000000000000005
location: string

Location

Example: 30100000200000000000000000000005 or ALL_SITES or ALL_DEPOTS
lotId: string

Lot Id

Example: B1B8327AFAA6412287106192AB5984EF

{
    "required":[
        "kit type Ids"
    ],
    "type":"object",
    "properties":{
        "location":{
            "type":"string",
            "description":"Location",
            "example":"30100000200000000000000000000005 or ALL_SITES or ALL_DEPOTS"
        },
        "labelGroupId":{
            "type":"string",
            "description":"Label group id",
            "example":"30100000200000000000000000000005"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "Kit Status":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"Integer",
            "example":"10",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        },
        "kit type Ids":{
            "type":"array",
            "description":"kit type selected.",
            "example":[
                "30100000600000000000000000000000",
                "40100000600000000000000000000000"
            ],
            "items":{
                "type":"string",
                "description":"kit type selected.",
                "example":"[30100000600000000000000000000000,40100000600000000000000000000000]"
            }
        }
    }
}

Nested Schema : kits

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : kit type Ids

Type: array

kit type selected.

Show Source

Array of: string

kit type selected.

Example: [30100000600000000000000000000000,40100000600000000000000000000000]

{
    "type":"array",
    "description":"kit type selected.",
    "example":[
        "30100000600000000000000000000000",
        "40100000600000000000000000000000"
    ],
    "items":{
        "type":"string",
        "description":"kit type selected.",
        "example":"[30100000600000000000000000000000,40100000600000000000000000000000]"
    }
}

Example:

[
    "30100000600000000000000000000000",
    "40100000600000000000000000000000"
]

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

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

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

400 Response

Invalid update request

Root Schema : Response

Type: object

Show Source

allowedMethods: array allowedMethods

Unique Items Required: true
closed: boolean
cookies: object cookies

Additional Properties Allowed: NewCookie
date: string (date-time)
entity: object entity
entityTag: object EntityTag
headers: object headers

Additional Properties Allowed: additionalProperties
language: object language
lastModified: string (date-time)
length: integer (int32)
links: array links

Unique Items Required: true
location: string (uri)
mediaType: object MediaType
metadata: object metadata

Additional Properties Allowed: additionalProperties
status: integer (int32)
statusInfo: object StatusType
stringHeaders: object stringHeaders

Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "location":{
            "type":"string",
            "format":"uri"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                }
            }
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "closed":{
            "type":"boolean"
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "statusInfo":{
            "$ref":"#/components/schemas/StatusType"
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/NewCookie"
            }
        },
        "entityTag":{
            "$ref":"#/components/schemas/EntityTag"
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : allowedMethods

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : cookies

Type: object

Additional Properties Allowed

Show Source

object NewCookie

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/NewCookie"
    }
}

Nested Schema : entity

Type: object

Nested Schema : EntityTag

Type: object

Show Source

value: string
weak: boolean

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "weak":{
            "type":"boolean"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : language

Type: object

Show Source

country: string
displayCountry: string
displayLanguage: string
displayName: string
displayScript: string
displayVariant: string
extensionKeys: array extensionKeys

Unique Items Required: true
iso3Country: string
iso3Language: string
language: string
script: string
unicodeLocaleAttributes: array unicodeLocaleAttributes

Unique Items Required: true
unicodeLocaleKeys: array unicodeLocaleKeys

Unique Items Required: true
variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

Array of: object Link

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : MediaType

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
subtype: string
type: string
wildcardSubtype: boolean
wildcardType: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean"
        },
        "wildcardSubtype":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : StatusType

Type: object

Show Source

family: string

Allowed Values: [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
reasonPhrase: string
statusCode: integer (int32)

{
    "type":"object",
    "properties":{
        "family":{
            "type":"string",
            "enum":[
                "INFORMATIONAL",
                "SUCCESSFUL",
                "REDIRECTION",
                "CLIENT_ERROR",
                "SERVER_ERROR",
                "OTHER"
            ]
        },
        "reasonPhrase":{
            "type":"string"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : stringHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : NewCookie

Type: object

Show Source

comment: string
domain: string
expiry: string (date-time)
httpOnly: boolean
maxAge: integer (int32)
name: string
path: string
sameSite: string

Allowed Values: [ "NONE", "LAX", "STRICT" ]
secure: boolean
value: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "path":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "maxAge":{
            "type":"integer",
            "format":"int32"
        },
        "expiry":{
            "type":"string",
            "format":"date-time"
        },
        "secure":{
            "type":"boolean"
        },
        "httpOnly":{
            "type":"boolean"
        },
        "sameSite":{
            "type":"string",
            "enum":[
                "NONE",
                "LAX",
                "STRICT"
            ]
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Show Source

params: object params

Additional Properties Allowed: additionalProperties
rel: string
rels: array rels
title: string
type: string
uri: string (uri)
uriBuilder: object UriBuilder

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "title":{
            "type":"string"
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "uriBuilder":{
            "$ref":"#/components/schemas/UriBuilder"
        },
        "rel":{
            "type":"string"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : rels

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : UriBuilder

Type: object

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

Internal server error

Root Schema : Response

Type: object

Show Source

allowedMethods: array allowedMethods

Unique Items Required: true
closed: boolean
cookies: object cookies

Additional Properties Allowed: NewCookie
date: string (date-time)
entity: object entity
entityTag: object EntityTag
headers: object headers

Additional Properties Allowed: additionalProperties
language: object language
lastModified: string (date-time)
length: integer (int32)
links: array links

Unique Items Required: true
location: string (uri)
mediaType: object MediaType
metadata: object metadata

Additional Properties Allowed: additionalProperties
status: integer (int32)
statusInfo: object StatusType
stringHeaders: object stringHeaders

Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "location":{
            "type":"string",
            "format":"uri"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                }
            }
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "closed":{
            "type":"boolean"
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "statusInfo":{
            "$ref":"#/components/schemas/StatusType"
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/NewCookie"
            }
        },
        "entityTag":{
            "$ref":"#/components/schemas/EntityTag"
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        }
    }
}

Nested Schema : allowedMethods

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : cookies

Type: object

Additional Properties Allowed

Show Source

object NewCookie

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/NewCookie"
    }
}

Nested Schema : entity

Type: object

Nested Schema : EntityTag

Type: object

Show Source

value: string
weak: boolean

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "weak":{
            "type":"boolean"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : language

Type: object

Show Source

country: string
displayCountry: string
displayLanguage: string
displayName: string
displayScript: string
displayVariant: string
extensionKeys: array extensionKeys

Unique Items Required: true
iso3Country: string
iso3Language: string
language: string
script: string
unicodeLocaleAttributes: array unicodeLocaleAttributes

Unique Items Required: true
unicodeLocaleKeys: array unicodeLocaleKeys

Unique Items Required: true
variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

Array of: object Link

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : MediaType

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
subtype: string
type: string
wildcardSubtype: boolean
wildcardType: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean"
        },
        "wildcardSubtype":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : StatusType

Type: object

Show Source

family: string

Allowed Values: [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
reasonPhrase: string
statusCode: integer (int32)

{
    "type":"object",
    "properties":{
        "family":{
            "type":"string",
            "enum":[
                "INFORMATIONAL",
                "SUCCESSFUL",
                "REDIRECTION",
                "CLIENT_ERROR",
                "SERVER_ERROR",
                "OTHER"
            ]
        },
        "reasonPhrase":{
            "type":"string"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : stringHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : NewCookie

Type: object

Show Source

comment: string
domain: string
expiry: string (date-time)
httpOnly: boolean
maxAge: integer (int32)
name: string
path: string
sameSite: string

Allowed Values: [ "NONE", "LAX", "STRICT" ]
secure: boolean
value: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "path":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "maxAge":{
            "type":"integer",
            "format":"int32"
        },
        "expiry":{
            "type":"string",
            "format":"date-time"
        },
        "secure":{
            "type":"boolean"
        },
        "httpOnly":{
            "type":"boolean"
        },
        "sameSite":{
            "type":"string",
            "enum":[
                "NONE",
                "LAX",
                "STRICT"
            ]
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Show Source

params: object params

Additional Properties Allowed: additionalProperties
rel: string
rels: array rels
title: string
type: string
uri: string (uri)
uriBuilder: object UriBuilder

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "title":{
            "type":"string"
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "uriBuilder":{
            "$ref":"#/components/schemas/UriBuilder"
        },
        "rel":{
            "type":"string"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : rels

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : UriBuilder

Type: object

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}