Jump to

• Request
• Response

Get the number of open queries in a study for selected subjects

post

/ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/openQueryCount

Retrieves the number of queries with the status Open, by study ID for selected subjects

Request

Path Parameters

• mode(required): string
  Study mode.
• studyId(required): string
  Study ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : OpenQueryCountPostDTO v1.0

Type: object

Title: OpenQueryCountPostDTO v1.0

Open Query Count request payload

Show Source

• subjects(required): array subjects
  list of Subject Unique GUIDs

{
    "title":"OpenQueryCountPostDTO v1.0",
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "type":"array",
            "description":"list of Subject Unique GUIDs",
            "format":"uuid",
            "example":[
                "938D23FA6B7241CCA41BD627E5DB60DA",
                "699EF3745FC545589F186D2198F3C65E"
            ],
            "items":{
                "type":"string",
                "description":"list of Subject Unique GUIDs",
                "format":"uuid"
            }
        }
    },
    "description":"Open Query Count request payload"
}

Nested Schema : subjects

Type: array

list of Subject Unique GUIDs

Show Source

• Array of: string(uuid)
  list of Subject Unique GUIDs

{
    "type":"array",
    "description":"list of Subject Unique GUIDs",
    "format":"uuid",
    "example":[
        "938D23FA6B7241CCA41BD627E5DB60DA",
        "699EF3745FC545589F186D2198F3C65E"
    ],
    "items":{
        "type":"string",
        "description":"list of Subject Unique GUIDs",
        "format":"uuid"
    }
}

Example:

[
    "938D23FA6B7241CCA41BD627E5DB60DA",
    "699EF3745FC545589F186D2198F3C65E"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : QueryCountResults v2.0

Type: object

Title: QueryCountResults v2.0

Query Count result payload

Show Source

• errorData: string
• result: array result
• status: string
• version: integer (int32)

{
    "title":"QueryCountResults v2.0",
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "errorData":{
            "type":"string"
        },
        "result":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/QueryCountResults Entry"
            }
        }
    },
    "description":"Query Count result payload"
}

Nested Schema : result

Type: array

Show Source

• Array of: object QueryCountResults Entry v2.0
  Title: QueryCountResults Entry v2.0

  Query Count result payload entry

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

Nested Schema : QueryCountResults Entry v2.0

Type: object

Title: QueryCountResults Entry v2.0

Query Count result payload entry

Show Source

• answered: integer (int32)
• candidate: integer (int32)
• closed: integer (int32)
• deleted: integer (int32)
• eventId: string
• eventInstanceNumber: integer (int32)
• opened: integer (int32)
• subjectId: string
• subjectName: string
• totalQueries: integer (int32)

{
    "title":"QueryCountResults Entry v2.0",
    "type":"object",
    "properties":{
        "subjectName":{
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "eventInstanceNumber":{
            "type":"integer",
            "format":"int32"
        },
        "answered":{
            "type":"integer",
            "format":"int32"
        },
        "candidate":{
            "type":"integer",
            "format":"int32"
        },
        "opened":{
            "type":"integer",
            "format":"int32"
        },
        "deleted":{
            "type":"integer",
            "format":"int32"
        },
        "closed":{
            "type":"integer",
            "format":"int32"
        },
        "totalQueries":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Query Count result payload entry"
}

400 Response

Data is invalid.

Body ()

Root Schema : schema

Type: object

Show Source

• allowedMethods: array allowedMethods
  Unique Items Required: true
• cookies: object cookies
  Additional Properties Allowed: additionalProperties
• 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 statusInfo
• stringHeaders: object stringHeaders
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "title":{
                        "type":"string"
                    },
                    "params":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"string"
                        }
                    },
                    "uri":{
                        "type":"string",
                        "format":"uri"
                    },
                    "uriBuilder":{
                        "type":"object"
                    },
                    "rel":{
                        "type":"string"
                    },
                    "rels":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "type":{
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "mediaType":{
            "type":"object",
            "properties":{
                "type":{
                    "type":"string"
                },
                "subtype":{
                    "type":"string"
                },
                "parameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "wildcardType":{
                    "type":"boolean"
                },
                "wildcardSubtype":{
                    "type":"boolean"
                }
            }
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "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"
                    }
                }
            }
        },
        "entityTag":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string"
                },
                "weak":{
                    "type":"boolean"
                }
            }
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statusInfo":{
            "type":"object",
            "properties":{
                "family":{
                    "type":"string",
                    "enum":[
                        "INFORMATIONAL",
                        "SUCCESSFUL",
                        "REDIRECTION",
                        "CLIENT_ERROR",
                        "SERVER_ERROR",
                        "OTHER"
                    ]
                },
                "reasonPhrase":{
                    "type":"string"
                },
                "statusCode":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                }
            }
        },
        "location":{
            "type":"string",
            "format":"uri"
        }
    }
}

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 additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "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"
            }
        }
    }
}

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"
        },
        "script":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

• Array of: object items

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "title":{
                "type":"string"
            },
            "params":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "uri":{
                "type":"string",
                "format":"uri"
            },
            "uriBuilder":{
                "type":"object"
            },
            "rel":{
                "type":"string"
            },
            "rels":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "type":{
                "type":"string"
            }
        }
    }
}

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

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

Type: object

Show Source

• comment: string
• domain: string
• expiry: string (date-time)
• httpOnly: boolean
• maxAge: integer (int32)
• name: string
• path: string
• 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"
        }
    }
}

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

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":{
        "title":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "uriBuilder":{
            "type":"object"
        },
        "rel":{
            "type":"string"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "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"
    }
}

404 Response

The query could not be found.

Body ()

Root Schema : schema

Type: object

Show Source

• allowedMethods: array allowedMethods
  Unique Items Required: true
• cookies: object cookies
  Additional Properties Allowed: additionalProperties
• 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 statusInfo
• stringHeaders: object stringHeaders
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "title":{
                        "type":"string"
                    },
                    "params":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"string"
                        }
                    },
                    "uri":{
                        "type":"string",
                        "format":"uri"
                    },
                    "uriBuilder":{
                        "type":"object"
                    },
                    "rel":{
                        "type":"string"
                    },
                    "rels":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "type":{
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "mediaType":{
            "type":"object",
            "properties":{
                "type":{
                    "type":"string"
                },
                "subtype":{
                    "type":"string"
                },
                "parameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "wildcardType":{
                    "type":"boolean"
                },
                "wildcardSubtype":{
                    "type":"boolean"
                }
            }
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "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"
                    }
                }
            }
        },
        "entityTag":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string"
                },
                "weak":{
                    "type":"boolean"
                }
            }
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statusInfo":{
            "type":"object",
            "properties":{
                "family":{
                    "type":"string",
                    "enum":[
                        "INFORMATIONAL",
                        "SUCCESSFUL",
                        "REDIRECTION",
                        "CLIENT_ERROR",
                        "SERVER_ERROR",
                        "OTHER"
                    ]
                },
                "reasonPhrase":{
                    "type":"string"
                },
                "statusCode":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                }
            }
        },
        "location":{
            "type":"string",
            "format":"uri"
        }
    }
}

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 additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "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"
            }
        }
    }
}

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"
        },
        "script":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

• Array of: object items

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "title":{
                "type":"string"
            },
            "params":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "uri":{
                "type":"string",
                "format":"uri"
            },
            "uriBuilder":{
                "type":"object"
            },
            "rel":{
                "type":"string"
            },
            "rels":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "type":{
                "type":"string"
            }
        }
    }
}

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

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

Type: object

Show Source

• comment: string
• domain: string
• expiry: string (date-time)
• httpOnly: boolean
• maxAge: integer (int32)
• name: string
• path: string
• 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"
        }
    }
}

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

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":{
        "title":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "uriBuilder":{
            "type":"object"
        },
        "rel":{
            "type":"string"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "type":{
            "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