Jump to

• Request
• Response

[Deprecated]: V1.0

put

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/randomizationnumber/{randNumber}

Deprecated: Updates randomization number when called by ORS service.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• randNumber(required): string
  RandomNumber to be updated.
• studyId(required): string
  ID of the study to which the subject belongs.
• subjectId(required): string(uuid)
  ID of the subject for whom you want to update details.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

RandomNumber is updated successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Subject1
  Comprehensive subject details including identity, site, study, demographic and state details, with example showing all fields.

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

Nested Schema : Subject1

Type: object

Comprehensive subject details including identity, site, study, demographic and state details, with example showing all fields.

Show Source

• canBeCompleted: boolean
  Indicates if the subject can be completed (UI-only transient flag).

  Example: true
• canBeReplaced: boolean
  Indicates if the subject randomization can be replaced (UI-only transient flag).

  Example: false
• canBeUndoWithdrawn: boolean
  Indicates if the subject's withdrawal can be undone (UI-only transient flag).

  Example: true
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment regarding the last change made to the entity.

  Example: Imported via migration tool.
• description: string
  Minimum Length: 0

  Maximum Length: 500

  Description of the subject record.

  Example: Screened subject record
• dob: string (date-time)
  Date of birth of the subject.
• enrollmentFailure: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for enrollment failure (if the subject is not enrolled).

  Example: Consent Required
• enrollmentOverride: string
  Minimum Length: 0

  Maximum Length: 255

  Administrative override details for subject enrollment, if any.

  Example: Subject enrollment overidden
• freezedStatus: string
  Frozen status of the record can have values NOT_APPLICABLE, FROZEN.

  Example: FROZEN
• fromStudyId: string (uuid)
  Originating study id for transferred subjects UUID, 32-character uppercase hexadecimal string.
• gender: string
  Minimum Length: 0

  Maximum Length: 10

  Subject gender: typically 'male', 'female', or 'other'.

  Example: male
• hasLockData: boolean
  Indicates if any data is locked for this subject (boolean, transient).

  Example: false
• id: string (uuid)
  Subject unique identifier (UUID, 32-character uppercase hexadecimal string) .
• informedConsentDate: string (date-time)
  Date the subject provided informed consent.
• lastSigned: string
  The timestamp or user who last signed the subject data, if transiently tracked.

  Example: 2025-10-15T08:00:00.000Z
• lockedDateTime: string (date-time)
  When this subject was locked, if at all (ISO date-time string).

  Example: 2025-10-18T11:05:00Z
• lockedInStudyVersion: string
  The study version string when the subject was locked.

  Example: 1.0.0.0
• lockedStatus: string
  Current locked status of the subject record from UI perspective.Values can be LOCKED, NEVER_LOCAKED, UNLOCKED, NOT_APPLICABLE

  Example: LOCKED
• mhealthSubjectId: string (uuid)
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the subject in mHealth system.
• operationType: string
  Minimum Length: 1

  Maximum Length: 16

  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: REMOVED
• previousSubjectNumber: string
  The previous subject number, for audit/tracking purposes (if the subject number changed).

  Example: SUBJ-0177
• randomizationNumber: string
  The randomization number assigned to the subject.

  Example: RAND-00235
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the entity creation or latest modification.

  Example: Initial import.
• replaceRand: string
  Indicates if subject's randomization was replaced (Y/N).

  Example: Y
• reScreenEventInstanceNum: number
  Number of times the subject was re-screened (transient, computed on the fly).

  Example: 2
• screenFailureComment: string
  Extended comment about screen failure.

  Example: comment for screen failure
• screenFailureDate: string (date-time)
  The date the subject failed screening, if applicable.
• screeningFailure: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for subject screen failure, if applicable.

  Example: Lost to follow up
• sdvSelectionStatus: string
  Source data verification selection status for the subject it can be NOT_SELECTED, INITIALCOUNT_SELECTED, POST_INITIALCOUNT_SELECTED.

  Example: NOT_SELECTED
• signedStatus: string
  Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.

  Example: SIGNED
• siteId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example: BEEFAABBCCDDEEDDFF00112233445566
• state(required): string
  Minimum Length: 0

  Maximum Length: 100

  Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.

  Example: Screened
• stateDate: string (date-time)
  Timestamp when the 'state' was updated.

  Example: 2025-10-01T09:00:01Z
• studyCompletionDate: string (date-time)
  Date the subject completed the study.

  Example: 2025-10-01T09:00:01Z
• studyVersion: string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.0
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  Unique subject Number representing the patient/participant enrolled in the study.

  Example: SUBJ-0199
• subjectSDVUpdated: boolean
  Indicates if the subject's Source Data Verification has been updated.

  Example: true
• subjNumSiteOrgId: string
  Organization/site identifier for subject number context.

  Example: AABBCC11223344556677
• totalAllowedRescreenLimit: string
  The maximum number of rescreens allowed for the subject (transient, calculated).

  Example: 3
• unblindComment: string
  Further comment on unblinding.

  Example: required comment
• unblindDate: string (date-time)
  Date/time the subject was unblinded.

  Example: 2025-10-01T09:00:01Z
• unblindReason: string
  Reason for subject being unblinded.

  Example: Reason
• verifiedStatus: string
  Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.

  Example: VERIFIED
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2025-10-16T14:30:31.892Z
• withdrawalComment: string
  Comment on withdrawal.

  Example: comment for withdrawal
• withdrawalDate: string (date-time)
  Date the subject was withdrawn from the study.

  Example: 2025-10-01T09:00:01Z
• withdrawalReason: string
  Reason for withdrawal.

  Example: reason for withdrawal

{
    "required":[
        "state",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the entity creation or latest modification.",
            "example":"Initial import."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment regarding the last change made to the entity.",
            "example":"Imported via migration tool."
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"REMOVED"
        },
        "id":{
            "type":"string",
            "description":"Subject unique identifier  (UUID, 32-character uppercase hexadecimal string) .",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Description of the subject record.",
            "example":"Screened subject record"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0199"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"BEEFAABBCCDDEEDDFF00112233445566"
        },
        "dob":{
            "type":"string",
            "description":"Date of birth of the subject.",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Lifecycle state of the subject.The state can be New, Active, Screening_Initiated, Screen_Failed, Withdrawn, Auto_Screen_Failed, Complete or Enrolled.",
            "example":"Screened"
        },
        "stateDate":{
            "type":"string",
            "description":"Timestamp when the 'state' was updated.",
            "format":"date-time",
            "example":"2025-10-01T09:00:01Z"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for subject screen failure, if applicable.",
            "example":"Lost to follow up"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for enrollment failure (if the subject is not enrolled).",
            "example":"Consent Required"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Administrative override details for subject enrollment, if any.",
            "example":"Subject enrollment overidden"
        },
        "informedConsentDate":{
            "type":"string",
            "description":"Date the subject provided informed consent.",
            "format":"date-time"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string",
            "description":"Subject gender: typically 'male', 'female', or 'other'.",
            "example":"male"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.0"
        },
        "mhealthSubjectId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string)  of the subject in mHealth system.",
            "format":"uuid"
        },
        "fromStudyId":{
            "type":"string",
            "description":"Originating study id for transferred subjects UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "subjNumSiteOrgId":{
            "type":"string",
            "description":"Organization/site identifier for subject number context.",
            "example":"AABBCC11223344556677"
        },
        "sdvSelectionStatus":{
            "type":"string",
            "description":"Source data verification selection status for the subject it can be NOT_SELECTED, INITIALCOUNT_SELECTED, POST_INITIALCOUNT_SELECTED.",
            "example":"NOT_SELECTED"
        },
        "withdrawalDate":{
            "type":"string",
            "description":"Date the subject was withdrawn from the study.",
            "format":"date-time",
            "example":"2025-10-01T09:00:01Z"
        },
        "studyCompletionDate":{
            "type":"string",
            "description":"Date the subject completed the study.",
            "format":"date-time",
            "example":"2025-10-01T09:00:01Z"
        },
        "unblindDate":{
            "type":"string",
            "description":"Date/time the subject was unblinded.",
            "format":"date-time",
            "example":"2025-10-01T09:00:01Z"
        },
        "unblindReason":{
            "type":"string",
            "description":"Reason for subject being unblinded.",
            "example":"Reason"
        },
        "unblindComment":{
            "type":"string",
            "description":"Further comment on unblinding.",
            "example":"required comment"
        },
        "withdrawalReason":{
            "type":"string",
            "description":"Reason for withdrawal.",
            "example":"reason for withdrawal"
        },
        "withdrawalComment":{
            "type":"string",
            "description":"Comment on withdrawal.",
            "example":"comment for withdrawal"
        },
        "screenFailureComment":{
            "type":"string",
            "description":"Extended comment about screen failure.",
            "example":"comment for screen failure"
        },
        "replaceRand":{
            "type":"string",
            "description":"Indicates if subject's randomization was replaced (Y/N).",
            "example":"Y"
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status for workflow, the acceptable values are:  NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.",
            "example":"SIGNED"
        },
        "canBeCompleted":{
            "type":"boolean",
            "description":"Indicates if the subject can be completed (UI-only transient flag).",
            "example":true
        },
        "canBeReplaced":{
            "type":"boolean",
            "description":"Indicates if the subject randomization can be replaced (UI-only transient flag).",
            "example":false
        },
        "canBeUndoWithdrawn":{
            "type":"boolean",
            "description":"Indicates if the subject's withdrawal can be undone (UI-only transient flag).",
            "example":true
        },
        "reScreenEventInstanceNum":{
            "type":"number",
            "description":"Number of times the subject was re-screened (transient, computed on the fly).",
            "example":2
        },
        "totalAllowedRescreenLimit":{
            "type":"string",
            "description":"The maximum number of rescreens allowed for the subject (transient, calculated).",
            "example":"3"
        },
        "previousSubjectNumber":{
            "type":"string",
            "description":"The previous subject number, for audit/tracking purposes (if the subject number changed).",
            "example":"SUBJ-0177"
        },
        "subjectSDVUpdated":{
            "type":"boolean",
            "description":"Indicates if the subject's Source Data Verification has been updated.",
            "example":true
        },
        "randomizationNumber":{
            "type":"string",
            "description":"The randomization number assigned to the subject.",
            "example":"RAND-00235"
        },
        "screenFailureDate":{
            "type":"string",
            "description":"The date the subject failed screening, if applicable.",
            "format":"date-time"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Frozen status of the record can have values NOT_APPLICABLE, FROZEN.",
            "example":"FROZEN"
        },
        "lastSigned":{
            "type":"string",
            "description":"The timestamp or user who last signed the subject data, if transiently tracked.",
            "example":"2025-10-15T08:00:00.000Z"
        },
        "lockedStatus":{
            "type":"string",
            "description":"Current locked status of the subject record from UI perspective.Values can be LOCKED, NEVER_LOCAKED, UNLOCKED, NOT_APPLICABLE",
            "example":"LOCKED"
        },
        "hasLockData":{
            "type":"boolean",
            "description":"Indicates if any data is locked for this subject (boolean, transient).",
            "example":false
        },
        "lockedDateTime":{
            "type":"string",
            "description":"When this subject was locked, if at all (ISO date-time string).",
            "format":"date-time",
            "example":"2025-10-18T11:05:00Z"
        },
        "lockedInStudyVersion":{
            "type":"string",
            "description":"The study version string when the subject was locked.",
            "example":"1.0.0.0"
        }
    },
    "description":"Comprehensive subject details including identity, site, study, demographic and state details, with example showing all fields."
}

400 Response

Bad request.

Body ()

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":{
        "closed":{
            "type":"boolean"
        },
        "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"
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/NewCookie"
            }
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "entityTag":{
            "$ref":"#/components/schemas/EntityTag"
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statusInfo":{
            "$ref":"#/components/schemas/StatusType"
        },
        "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"
            }
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "title":{
            "type":"string"
        },
        "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"
    }
}

Back to Top