diff --git a/qqq-middleware-api/src/test/resources/many-tables.yaml b/qqq-middleware-api/src/test/resources/many-tables.yaml deleted file mode 100644 index acd9c0d8..00000000 --- a/qqq-middleware-api/src/test/resources/many-tables.yaml +++ /dev/null @@ -1,252 +0,0 @@ -openapi: "3.0.3" -info: - title: "QQQ API" - description: "This is your api description!\n" - termsOfService: "https://swagger.io/terms/" - contact: - email: "apiteam@swagger.io" - license: - name: "Apache 2.0" - url: "https://www.apache.org/licenses/LICENSE-2.0.html" - version: "1.0.11" -externalDocs: - description: "Find out more at:" - url: "https://swagger.io" -servers: - - url: "https://petstore3.swagger.io/api/v3" -tags: - - name: "person" - description: "Operations on the Person table." - - name: "personFile" - description: "Operations on the Person File table." - - name: "personMemory" - description: "Operations on the Person Memory table." - - name: "personMemoryCache" - description: "Operations on the Person Memory Cache table." - - name: "idAndNameOnly" - description: "Operations on the Id and Name Only table." - - name: "shape" - description: "Operations on the Shape table." - - name: "basepullTest" - description: "Operations on the Basepull Test table." - - name: "order" - description: "Operations on the Order table." - - name: "orderLine" - description: "Operations on the Order Line table." -paths: - /person/{id}: - get: - summary: "Find Person by Id" - description: "Returns a single Person" - operationId: "getPersonById" - responses: - "200": - description: "Successfully got Person" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Person to return" - required: true - tags: - - "person" - /personFile/{id}: - get: - summary: "Find Person File by Id" - description: "Returns a single Person File" - operationId: "getPersonFileById" - responses: - "200": - description: "Successfully got Person File" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Person File to return" - required: true - tags: - - "personFile" - /personMemory/{id}: - get: - summary: "Find Person Memory by Id" - description: "Returns a single Person Memory" - operationId: "getPersonMemoryById" - responses: - "200": - description: "Successfully got Person Memory" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Person Memory to return" - required: true - tags: - - "personMemory" - /personMemoryCache/{id}: - get: - summary: "Find Person Memory Cache by Id" - description: "Returns a single Person Memory Cache" - operationId: "getPersonMemoryCacheById" - responses: - "200": - description: "Successfully got Person Memory Cache" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Person Memory Cache to return" - required: true - tags: - - "personMemoryCache" - /idAndNameOnly/{id}: - get: - summary: "Find Id and Name Only by Id" - description: "Returns a single Id and Name Only" - operationId: "getIdAndNameOnlyById" - responses: - "200": - description: "Successfully got Id and Name Only" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Id and Name Only to return" - required: true - tags: - - "idAndNameOnly" - /shape/{id}: - get: - summary: "Find Shape by Id" - description: "Returns a single Shape" - operationId: "getShapeById" - responses: - "200": - description: "Successfully got Shape" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Shape to return" - required: true - tags: - - "shape" - /basepullTest/{id}: - get: - summary: "Find Basepull Test by Id" - description: "Returns a single Basepull Test" - operationId: "getBasepullTestById" - responses: - "200": - description: "Successfully got Basepull Test" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Basepull Test to return" - required: true - tags: - - "basepullTest" - /order/{id}: - get: - summary: "Find Order by Id" - description: "Returns a single Order" - operationId: "getOrderById" - responses: - "200": - description: "Successfully got Order" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Order to return" - required: true - tags: - - "order" - /orderLine/{id}: - get: - summary: "Find Order Line by Id" - description: "Returns a single Order Line" - operationId: "getOrderLineById" - responses: - "200": - description: "Successfully got Order Line" - "401": - description: "Unauthorized. Security credentials were either missing or\ - \ invalid." - "403": - description: "Forbidden. The credentials provided do not have permission\ - \ to access the requested resource." - parameters: - - schema: - format: "int32" - type: "integer" - in: "path" - name: "id" - description: "Id of Order Line to return" - required: true - tags: - - "orderLine" \ No newline at end of file diff --git a/qqq-middleware-api/src/test/resources/person-many-endpoints.yaml b/qqq-middleware-api/src/test/resources/person-many-endpoints.yaml deleted file mode 100644 index f24b97b0..00000000 --- a/qqq-middleware-api/src/test/resources/person-many-endpoints.yaml +++ /dev/null @@ -1,676 +0,0 @@ -info: - title: QQQ API - description: This is your api description! - ## termsOfService: https://swagger.io/terms/ - contact: - email: contact@kingsrook.com - version: 0.0.1 -#externalDocs: -# description: Find out more at -# url: https://swagger.io -servers: - - description: Localhost development - url: http://localhost:8000/api/ -tags: - - name: person - description: Operations on the Person table. -paths: - /person/query: - get: - summary: Search the Person table using multiple query string fields. - description: | - Returns Person records matching the query parameters.
- Each query field can be supplied multiple times to add additional criteria.
- Query values can be prefixed with an operator (=, <, <=, >, >=, IN, MATCHES, EMPTY, BETWEEN). The default operator if only a value is given is =.
- Operators can be prefixed with a ! to be negated.
- Operators which are a word (IN, MATCHES, EMPTY, BETWEEN) must be followed by a space.
- Values for operators which take multiple values (IN, BETWEEN) must be comma delimited.
- operationId: queryPerson - tags: [person] - parameters: - - name: pageNo - description: Which page of results to return. Starts at 1. - in: query - schema: - type: integer - - name: pageSize - description: Max number of records to include in a page. Defaults to 50. - in: query - schema: - type: integer - - name: includeCount - in: query - description: | - Whether or not to include the count (total matching records) in the result.
- In some situations, counts can slow down queries, in which case you may want to specify includeCount=false.
- Default is true.
- schema: - type: boolean - - name: booleanOperator - in: query - description: Whether to join query field as an AND or an OR. Default is AND. - schema: - type: string - enum: ["AND", "OR"] - - name: orderBy - in: query - schema: - type: string - examples: - id: - summary: order by id (by default, is ascending) - value: id - idDesc: - summary: order by id descending - value: id asc - idAsc: - summary: order by id ascending (explicitly specified) - value: id asc - stateCity: - summary: order by state, then by city (both ascending) - value: state, city - ratingPriceSku: - summary: rating descending, then price ascending, then sku - value: rating desc, price asc, sku - - name: id - in: query - description: Query on the id field. Can prefix value with an operator, else defaults to = (equals). - schema: - type: array - items: - type: string - explode: true - examples: - equals47: - $ref: "#/components/examples/equals47" - between42and47: - $ref: "#/components/examples/between42and47" - multiple: - $ref: "#/components/examples/multipleNumbers" - - name: firstName - in: query - description: Query on the firstName field. Can prefix value with an operator, else defaults to = (equals). - schema: - type: array - items: - type: string - examples: - equalsJohn: - $ref: "#/components/examples/equalsJohn" - inJohnPaul: - $ref: "#/components/examples/inJohnPaul" - multipleStrings: - $ref: "#/components/examples/multipleStrings" - explode: true - - name: lastName - in: query - description: Query on the lastName field. Can prefix value with an operator, else defaults to = (equals). - schema: - type: array - items: - type: string - examples: - equalsJohn: - $ref: "#/components/examples/equalsJohn" - inJohnPaul: - $ref: "#/components/examples/inJohnPaul" - multipleStrings: - $ref: "#/components/examples/multipleStrings" - explode: true - responses: - 200: - content: - application/json: - schema: - $ref: "#/components/schemas/personSearchResult" - description: Successfully searched Person table (though may have found 0 records). - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - post: - summary: Search the Person table using a posted query object - description: | - Returns Person records matching the query parameters. - operationId: queryPerson - tags: [person] - requestBody: - required: true - description: | - List of search fields from the person table. - Each field must include its operator, and per operator, 0 or more values, always specified as an array. - Fields may appear multiple times. All fields will be combined using the specified (query parameter) booleanOperator. - content: - application/json: - schema: - type: object - properties: - booleanOperator: - description: Whether to join query field as an AND or an OR. Default is AND. - type: string - enum: ["AND", "OR"] - criteria: - type: array - items: - type: object - properties: - fieldName: - type: string - operator: - type: string - enum: [EQUALS, NOT_EQUALS, etc] - values: - type: array - items: - type: string - ## todo - subfilters!! - example: - - fieldName: firstName - operator: EQUALS - values: ["John"] - - fieldName: id - operator: IN - values: [1,2,3] - parameters: - - name: pageNo - description: Which page of results to return. Starts at 1. - in: query - schema: - type: integer - - name: pageSize - description: Max number of records to include in a page. Defaults to 50. - in: query - schema: - type: integer - - name: includeCount - in: query - description: | - Whether or not to include the count (total matching records) in the result.
- In some situations, counts can slow down queries, in which case you may want to specify includeCount=false.
- Default is true.
- schema: - type: boolean - - name: booleanOperator - in: query - description: Whether to join query field as an AND or an OR. Default is AND. - schema: - type: string - enum: ["AND", "OR"] - - name: orderBy - in: query - schema: - type: string - examples: - id: - summary: order by id (by default, is ascending) - value: id - idDesc: - summary: order by id descending - value: id asc - idAsc: - summary: order by id ascending (explicitly specified) - value: id asc - stateCity: - summary: order by state, then by city (both ascending) - value: state, city - ratingPriceSku: - summary: rating descending, then price ascending, then sku - value: rating desc, price asc, sku - responses: - 200: - content: - application/json: - schema: - $ref: "#/components/schemas/personSearchResult" - description: Successfully searched Person table (though may have found 0 records). - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" -## /person/filter: -## get: -## summary: Search the Person table using an OData style $filter parameter -## description: Returns Person records matching the query parameters -## operationId: filterPerson -## responses: -## 200: -## description: Successfully searched Person table (though may have 0 results) -## parameters: -## - name: $filter -## in: query -## schema: -## type: string -## items: -## type: string -## description: OData $filter style query string for Person records. See https://some.com/filter for info -## examples: -## simple: -## summary: id equals 42 -## value: id eq 42 -## complex: -## summary: id equals 42 and firstName like 'Jo%' -## value: id gt 47 and firstName like 'Jo%' -## tags: -## - person - /person/{id}: - get: - summary: Find Person by Id - description: Returns a single Person - operationId: getPerson - responses: - 200: - description: Successfully got Person - content: - application/json: - schema: - $ref: "#/components/schemas/person" - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 404: - $ref: "#/components/responses/404" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - parameters: - - schema: - type: integer - in: path - name: id - description: Id of Person to return - required: true - tags: - - person - patch: - summary: Update one Person - description: Updates one Person record - operationId: updatePerson - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/personWithoutId" - parameters: - - schema: - type: integer - in: path - name: id - description: Id of Person to update - required: true - responses: - 200: - description: Successfully updated Person - tags: - - person - delete: - summary: Delete one Person - description: Deletes one Person record - operationId: deletePerson - responses: - 200: - description: Successfully deleted Person - tags: - - person - /person/: - post: - summary: Create one Person - description: Creates a single Person record - operationId: createPerson - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/personWithoutId" - responses: - 201: - description: Created. The person has been created. - content: - application/json: - schema: - type: object - properties: - id: - type: integer - example: 1701 - description: Generated id for the person that was inserted. - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - tags: - - person - /person/bulk: - patch: - summary: Update multiple Person records - description: Update multiple Person records - operationId: bulkUpdatePerson - requestBody: - content: - application/json: - example: - - id: 1701 - firstName: John - - id: 1702 - lastName: McCartney - schema: - type: array - items: - $ref: "#/components/schemas/person" - responses: - 207: - description: Multi-Status. See body for status of individual records. - content: - application/json: - schema: - type: array - items: - type: object - properties: - statusCode: - type: integer - description: HTTP status code for the record at this index. - example: 201 - statusMessage: - type: string - description: HTTP status message for the record at this index. - example: Created - id: - type: integer - description: Generated id, if applicable, for the record at this index. - example: 1701 - error: - type: string - description: Additional error details, if applicable, for the record at this index. - example: "Missing required field: firstName" - example: - - statusCode: 200 - statusMessage: OK - - statusCode: 400 - statusMessage: Bad Request - error: "Record cannot be deleted due to foreign key check" - - statusCode: 500 - statusMessage: Internal Server Error - error: Error connecting to database - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - tags: - - person - delete: - summary: Delete multiple Person records - description: Deletes multiple Person records - operationId: bulkDeletePerson - requestBody: - content: - application/json: - schema: - type: array - items: - type: integer - description: ids of the person records to be deleted - example: [42, 47] - responses: - 207: - description: Multi-Status. See body for status of individual records. - content: - application/json: - schema: - type: array - items: - type: object - properties: - statusCode: - type: integer - description: HTTP status code for the record at this index. - example: 201 - statusMessage: - type: string - description: HTTP status message for the record at this index. - example: Created - id: - type: integer - description: Generated id, if applicable, for the record at this index. - example: 1701 - error: - type: string - description: Additional error details, if applicable, for the record at this index. - example: "Missing required field: firstName" - example: - - statusCode: 201 - statusMessage: Created - id: 1701 - - statusCode: 400 - statusMessage: Bad Request - error: "Missing value for required field: firstName" - - statusCode: 500 - statusMessage: Internal Server Error - error: Error connecting to database - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - tags: - - person - post: - summary: Create multiple Person records - description: Creates multiple Person records - operationId: bulkCreatePerson - requestBody: - content: - application/json: - example: - - firstName: John - lastName: Lennon - - firstName: Paul - lastName: McCartney - - firstName: George - lastName: Harrison - schema: - type: array - items: - $ref: "#/components/schemas/personWithoutId" - responses: - 207: - description: Multi-Status. See body for status of individual records. - content: - application/json: - schema: - type: array - items: - type: object - properties: - statusCode: - type: integer - description: HTTP status code for the record at this index. - example: 201 - statusMessage: - type: string - description: HTTP status message for the record at this index. - example: Created - id: - type: integer - description: Generated id, if applicable, for the record at this index. - example: 1701 - error: - type: string - description: Additional error details, if applicable, for the record at this index. - example: "Missing required field: firstName" - example: - - statusCode: 201 - statusMessage: Created - id: 1701 - - statusCode: 400 - statusMessage: Bad Request - error: "Missing value for required field: firstName" - - statusCode: 500 - statusMessage: Internal Server Error - error: Error connecting to database - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - tags: - - person -components: - examples: - equals47: - summary: equal to 47 - value: - - "47" - between42and47: - summary: between 42 and 47 - value: - - BETWEEN 42,47 - multipleNumbers: - summary: between 42 and 47 and not equal to 45 - value: - - BETWEEN 42,47 - - "!=45" - equalsJohn: - summary: equal to "John" - value: - - "John" - inJohnPaul: - summary: in ("John", "Paul") - value: - - IN ("John","Paul") - multipleStrings: - summary: matches R* and is not Ringo - value: - - MATCHES R* - - "!=Ringo" - schemas: - personWithoutId: - type: object - properties: - firstName: - type: string - description: First Name of the person. - example: John - lastName: - type: string - description: Last Name of the person. - example: Lennon - person: - type: object - properties: - id: - type: integer - description: Id for the person. Primary Key. - example: 47 - allOf: - - $ref: "#/components/schemas/personWithoutId" - city: - type: object - properties: - id: - type: integer - description: Id for the city. Primary Key. - example: 47 - state: - type: string - description: State of the city. - example: MO -# allOf: -# - $ref: "#/components/schemas/personWithoutId" - baseSearchResultFields: - type: object - properties: - count: - type: integer - description: Number of records that matched the search criteria - pageNo: - type: integer - description: ... - pageSize: - type: integer - description: ... - personSearchResult: - type: object - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - properties: - records: - type: array - items: - allOf: - - $ref: "#/components/schemas/person" - - $ref: "#/components/schemas/personWithoutId" - responses: - 401: - description: Unauthorized. The required authentication credentials were missing or invalid. - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: The required authentication credentials were missing or invalid. - 403: - description: Forbidden. You do not have permission to access the requested resource. - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: Forbidden. You do not have permission to access the requested resource. - 404: - description: Not Found. The requested record was not found. - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: Not Found. The requested record was not found. - 400: - description: Bad Request. Some portion of the request's content was not acceptable to the server. See error message in body for details. - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: 'Parameter id should be given an integer value, but received string: "Foo"' - 500: - description: Internal Server Error. An error occurred in the server processing the request. - content: - application/json: - schema: - type: object - properties: - error: - type: string - example: Database connection error. Try again later. diff --git a/qqq-middleware-api/src/test/resources/wip.yaml b/qqq-middleware-api/src/test/resources/wip.yaml deleted file mode 100644 index dc9d67d0..00000000 --- a/qqq-middleware-api/src/test/resources/wip.yaml +++ /dev/null @@ -1,3271 +0,0 @@ - openapi: "3.0.3" - info: - title: "QQQ API" - description: "This is an openAPI built by QQQ" - contact: - email: "contact@kingsrook.com" - version: "2023.03" - servers: - - description: "Localhost development" - url: "http://localhost:8000/api" - tags: - - name: "Person" - description: "Operations on the Person table." - - name: "Person File" - description: "Operations on the Person File table." - - name: "Person Memory" - description: "Operations on the Person Memory table." - - name: "Person Memory Cache" - description: "Operations on the Person Memory Cache table." - - name: "Id and Name Only" - description: "Operations on the Id and Name Only table." - - name: "Shape" - description: "Operations on the Shape table." - - name: "Basepull Test" - description: "Operations on the Basepull Test table." - - name: "Order" - description: "Operations on the Order table." - - name: "Order Line" - description: "Operations on the Order Line table." - paths: - /person/query: - get: - summary: "Search the Person table using multiple query string fields." - description: "TODO" - operationId: "queryPerson" - tags: - - "Person" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - firstNameAndLastNameAndBirthDate: - summary: "order by firstName descending, then by lastName ascending, then\ - \ by birthDate" - value: "firstName desc, lastName asc, birthDate" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - required: false - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - allowEmptyValue: false - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - allowEmptyValue: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "firstName" - description: "Query on the First Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lastName" - description: "Query on the Last Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "birthDate" - description: "Query on the Birth Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "email" - description: "Query on the Email field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "homeStateId" - description: "Query on the Home State field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "favoriteShapeId" - description: "Query on the Favorite Shape field. Can prefix value with an\ - \ operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "customValue" - description: "Query on the Custom Value field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "noOfShoes" - description: "Query on the No Of Shoes field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "cost" - description: "Query on the Cost field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "price" - description: "Query on the Price field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Person table (though may have found\ - \ 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/personSearchResult" - /personFile/query: - get: - summary: "Search the Person File table using multiple query string fields." - description: "TODO" - operationId: "queryPersonFile" - tags: - - "Person File" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - firstNameAndLastNameAndBirthDate: - summary: "order by firstName descending, then by lastName ascending, then\ - \ by birthDate" - value: "firstName desc, lastName asc, birthDate" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "firstName" - description: "Query on the First Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lastName" - description: "Query on the Last Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "birthDate" - description: "Query on the Birth Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "email" - description: "Query on the Email field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "homeStateId" - description: "Query on the Home State field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "favoriteShapeId" - description: "Query on the Favorite Shape field. Can prefix value with an\ - \ operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "customValue" - description: "Query on the Custom Value field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "noOfShoes" - description: "Query on the No Of Shoes field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "cost" - description: "Query on the Cost field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "price" - description: "Query on the Price field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Person File table (though may have\ - \ found 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/personFileSearchResult" - /personMemory/query: - get: - summary: "Search the Person Memory table using multiple query string fields." - description: "TODO" - operationId: "queryPersonMemory" - tags: - - "Person Memory" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - firstNameAndLastNameAndBirthDate: - summary: "order by firstName descending, then by lastName ascending, then\ - \ by birthDate" - value: "firstName desc, lastName asc, birthDate" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "firstName" - description: "Query on the First Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lastName" - description: "Query on the Last Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "birthDate" - description: "Query on the Birth Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "email" - description: "Query on the Email field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "homeStateId" - description: "Query on the Home State field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "favoriteShapeId" - description: "Query on the Favorite Shape field. Can prefix value with an\ - \ operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "customValue" - description: "Query on the Custom Value field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "noOfShoes" - description: "Query on the No Of Shoes field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "cost" - description: "Query on the Cost field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "price" - description: "Query on the Price field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "qqqAutomationStatus" - description: "Query on the Qqq Automation Status field. Can prefix value\ - \ with an operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Person Memory table (though may\ - \ have found 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/personMemorySearchResult" - /personMemoryCache/query: - get: - summary: "Search the Person Memory Cache table using multiple query string fields." - description: "TODO" - operationId: "queryPersonMemoryCache" - tags: - - "Person Memory Cache" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - firstNameAndLastNameAndBirthDate: - summary: "order by firstName descending, then by lastName ascending, then\ - \ by birthDate" - value: "firstName desc, lastName asc, birthDate" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "firstName" - description: "Query on the First Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lastName" - description: "Query on the Last Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "birthDate" - description: "Query on the Birth Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "email" - description: "Query on the Email field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "homeStateId" - description: "Query on the Home State field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "favoriteShapeId" - description: "Query on the Favorite Shape field. Can prefix value with an\ - \ operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "customValue" - description: "Query on the Custom Value field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "noOfShoes" - description: "Query on the No Of Shoes field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "cost" - description: "Query on the Cost field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "price" - description: "Query on the Price field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "cachedDate" - description: "Query on the Cached Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Person Memory Cache table (though\ - \ may have found 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/personMemoryCacheSearchResult" - /idAndNameOnly/query: - get: - summary: "Search the Id and Name Only table using multiple query string fields." - description: "TODO" - operationId: "queryIdAndNameOnly" - tags: - - "Id and Name Only" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "name" - description: "Query on the Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Id and Name Only table (though may\ - \ have found 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/idAndNameOnlySearchResult" - /shape/query: - get: - summary: "Search the Shape table using multiple query string fields." - description: "TODO" - operationId: "queryShape" - tags: - - "Shape" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - nameAndTypeAndNoOfSides: - summary: "order by name descending, then by type ascending, then by noOfSides" - value: "name desc, type asc, noOfSides" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "name" - description: "Query on the Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "type" - description: "Query on the Type field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "noOfSides" - description: "Query on the No Of Sides field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "isPolygon" - description: "Query on the Is Polygon field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Shape table (though may have found\ - \ 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/shapeSearchResult" - /basepullTest/query: - get: - summary: "Search the Basepull Test table using multiple query string fields." - description: "TODO" - operationId: "queryBasepullTest" - tags: - - "Basepull Test" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - firstNameAndLastNameAndBirthDate: - summary: "order by firstName descending, then by lastName ascending, then\ - \ by birthDate" - value: "firstName desc, lastName asc, birthDate" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "firstName" - description: "Query on the First Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lastName" - description: "Query on the Last Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "birthDate" - description: "Query on the Birth Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "email" - description: "Query on the Email field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "homeStateId" - description: "Query on the Home State field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "favoriteShapeId" - description: "Query on the Favorite Shape field. Can prefix value with an\ - \ operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "customValue" - description: "Query on the Custom Value field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "noOfShoes" - description: "Query on the No Of Shoes field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "cost" - description: "Query on the Cost field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "price" - description: "Query on the Price field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "processName" - description: "Query on the Process Name field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lastRunTime" - description: "Query on the Last Run Time field. Can prefix value with an\ - \ operator, else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Basepull Test table (though may\ - \ have found 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/basepullTestSearchResult" - /order/query: - get: - summary: "Search the Order table using multiple query string fields." - description: "TODO" - operationId: "queryOrder" - tags: - - "Order" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - orderDateAndStoreIdAndTotal: - summary: "order by orderDate descending, then by storeId ascending, then\ - \ by total" - value: "orderDate desc, storeId asc, total" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "orderDate" - description: "Query on the Order Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "storeId" - description: "Query on the Store Id field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "total" - description: "Query on the Total field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Order table (though may have found\ - \ 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/orderSearchResult" - /orderLine/query: - get: - summary: "Search the Order Line table using multiple query string fields." - description: "TODO" - operationId: "queryOrderLine" - tags: - - "Order Line" - parameters: - - name: "pageNo" - description: "Which page of results to return. Starts at 1." - in: "query" - schema: - type: "integer" - - name: "pageSize" - description: "Max number of records to include in a page. Defaults to 50." - in: "query" - schema: - type: "integer" - - name: "includeCount" - description: "Whether or not to include the count (total matching records)\ - \ in the result. Default is true." - in: "query" - schema: - type: "boolean" - - name: "orderBy" - description: "How the results of the query should be sorted.
\nSQL-style,\ - \ comma-separated list of field names, each optionally followed by ASC or\ - \ DESC (defaults to ASC).\n" - in: "query" - schema: - type: "string" - examples: - id: - summary: "order by id (by default is ascending)" - value: "id" - idDesc: - summary: "order by id (descending)" - value: "id desc" - idAsc: - summary: "order by id (explicitly ascending)" - value: "id asc" - createDateAndModifyDate: - summary: "order by createDate, then by modifyDate (both ascending)" - value: "createDate, modifyDate" - orderIdAndLineNumberAndSku: - summary: "order by orderId descending, then by lineNumber ascending, then\ - \ by sku" - value: "orderId desc, lineNumber asc, sku" - - name: "booleanOperator" - description: "Whether to combine query field as an AND or an OR. Default\ - \ is AND." - in: "query" - schema: - type: "string" - enum: - - "AND" - - "OR" - - name: "id" - description: "Query on the Id field. Can prefix value with an operator, else\ - \ defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "createDate" - description: "Query on the Create Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "modifyDate" - description: "Query on the Modify Date field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "orderId" - description: "Query on the Order Id field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "lineNumber" - description: "Query on the Line Number field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "sku" - description: "Query on the Sku field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - - name: "quantity" - description: "Query on the Quantity field. Can prefix value with an operator,\ - \ else defaults to = (equals)." - in: "query" - schema: - type: "array" - items: - type: "string" - explode: true - examples: - notQueried: - summary: "No query on this field" - value: - - "" - equals: - summary: "equal to 47" - value: - - "47" - complex: - summary: "between 42 and 47 and not equal to 45" - value: - - "BETWEEN 42,47" - - "!=45" - responses: - 400: - $ref: "#/components/responses/400" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 500: - $ref: "#/components/responses/500" - 200: - description: "Successfully searched the Order Line table (though may have\ - \ found 0 records)." - content: - application/json: - schema: - $ref: "#/components/schemas/orderLineSearchResult" - components: - schemas: - baseSearchResultFields: - type: "object" - properties: - pageNo: - type: "integer" - description: "Requested result page number" - count: - type: "integer" - description: "Number of records that matched the search criteria" - pageSize: - type: "integer" - description: "Requested result page size" - personWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person." - createDate: - description: "Create Date for the Person." - modifyDate: - description: "Modify Date for the Person." - firstName: - type: "string" - description: "First Name for the Person." - lastName: - type: "string" - description: "Last Name for the Person." - birthDate: - description: "Birth Date for the Person." - email: - type: "string" - description: "Email for the Person." - homeStateId: - type: "integer" - description: "Home State for the Person." - favoriteShapeId: - type: "integer" - description: "Favorite Shape for the Person." - customValue: - type: "integer" - description: "Custom Value for the Person." - noOfShoes: - type: "integer" - description: "No Of Shoes for the Person." - cost: - description: "Cost for the Person." - price: - description: "Price for the Person." - person: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person. Primary Key." - allOf: - - $ref: "#/components/schemas/personWithoutPrimaryKey" - personSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/person" - - $ref: "#/components/schemas/personWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - personFileWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person File." - createDate: - description: "Create Date for the Person File." - modifyDate: - description: "Modify Date for the Person File." - firstName: - type: "string" - description: "First Name for the Person File." - lastName: - type: "string" - description: "Last Name for the Person File." - birthDate: - description: "Birth Date for the Person File." - email: - type: "string" - description: "Email for the Person File." - homeStateId: - type: "integer" - description: "Home State for the Person File." - favoriteShapeId: - type: "integer" - description: "Favorite Shape for the Person File." - customValue: - type: "integer" - description: "Custom Value for the Person File." - noOfShoes: - type: "integer" - description: "No Of Shoes for the Person File." - cost: - description: "Cost for the Person File." - price: - description: "Price for the Person File." - personFile: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person File. Primary Key." - allOf: - - $ref: "#/components/schemas/personFileWithoutPrimaryKey" - personFileSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/personFile" - - $ref: "#/components/schemas/personFileWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - personMemoryWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person Memory." - createDate: - description: "Create Date for the Person Memory." - modifyDate: - description: "Modify Date for the Person Memory." - firstName: - type: "string" - description: "First Name for the Person Memory." - lastName: - type: "string" - description: "Last Name for the Person Memory." - birthDate: - description: "Birth Date for the Person Memory." - email: - type: "string" - description: "Email for the Person Memory." - homeStateId: - type: "integer" - description: "Home State for the Person Memory." - favoriteShapeId: - type: "integer" - description: "Favorite Shape for the Person Memory." - customValue: - type: "integer" - description: "Custom Value for the Person Memory." - noOfShoes: - type: "integer" - description: "No Of Shoes for the Person Memory." - cost: - description: "Cost for the Person Memory." - price: - description: "Price for the Person Memory." - qqqAutomationStatus: - type: "integer" - description: "Qqq Automation Status for the Person Memory." - personMemory: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person Memory. Primary Key." - allOf: - - $ref: "#/components/schemas/personMemoryWithoutPrimaryKey" - personMemorySearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/personMemory" - - $ref: "#/components/schemas/personMemoryWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - personMemoryCacheWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person Memory Cache." - createDate: - description: "Create Date for the Person Memory Cache." - modifyDate: - description: "Modify Date for the Person Memory Cache." - firstName: - type: "string" - description: "First Name for the Person Memory Cache." - lastName: - type: "string" - description: "Last Name for the Person Memory Cache." - birthDate: - description: "Birth Date for the Person Memory Cache." - email: - type: "string" - description: "Email for the Person Memory Cache." - homeStateId: - type: "integer" - description: "Home State for the Person Memory Cache." - favoriteShapeId: - type: "integer" - description: "Favorite Shape for the Person Memory Cache." - customValue: - type: "integer" - description: "Custom Value for the Person Memory Cache." - noOfShoes: - type: "integer" - description: "No Of Shoes for the Person Memory Cache." - cost: - description: "Cost for the Person Memory Cache." - price: - description: "Price for the Person Memory Cache." - cachedDate: - description: "Cached Date for the Person Memory Cache." - personMemoryCache: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Person Memory Cache. Primary Key." - allOf: - - $ref: "#/components/schemas/personMemoryCacheWithoutPrimaryKey" - personMemoryCacheSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/personMemoryCache" - - $ref: "#/components/schemas/personMemoryCacheWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - idAndNameOnlyWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Id and Name Only." - name: - type: "string" - description: "Name for the Id and Name Only." - idAndNameOnly: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Id and Name Only. Primary Key." - allOf: - - $ref: "#/components/schemas/idAndNameOnlyWithoutPrimaryKey" - idAndNameOnlySearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/idAndNameOnly" - - $ref: "#/components/schemas/idAndNameOnlyWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - shapeWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Shape." - createDate: - description: "Create Date for the Shape." - modifyDate: - description: "Modify Date for the Shape." - name: - type: "string" - description: "Name for the Shape." - type: - type: "string" - description: "Type for the Shape." - noOfSides: - type: "integer" - description: "No Of Sides for the Shape." - isPolygon: - description: "Is Polygon for the Shape." - shape: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Shape. Primary Key." - allOf: - - $ref: "#/components/schemas/shapeWithoutPrimaryKey" - shapeSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/shape" - - $ref: "#/components/schemas/shapeWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - basepullTestWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Basepull Test." - createDate: - description: "Create Date for the Basepull Test." - modifyDate: - description: "Modify Date for the Basepull Test." - firstName: - type: "string" - description: "First Name for the Basepull Test." - lastName: - type: "string" - description: "Last Name for the Basepull Test." - birthDate: - description: "Birth Date for the Basepull Test." - email: - type: "string" - description: "Email for the Basepull Test." - homeStateId: - type: "integer" - description: "Home State for the Basepull Test." - favoriteShapeId: - type: "integer" - description: "Favorite Shape for the Basepull Test." - customValue: - type: "integer" - description: "Custom Value for the Basepull Test." - noOfShoes: - type: "integer" - description: "No Of Shoes for the Basepull Test." - cost: - description: "Cost for the Basepull Test." - price: - description: "Price for the Basepull Test." - processName: - type: "string" - description: "Process Name for the Basepull Test." - lastRunTime: - description: "Last Run Time for the Basepull Test." - basepullTest: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Basepull Test. Primary Key." - allOf: - - $ref: "#/components/schemas/basepullTestWithoutPrimaryKey" - basepullTestSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/basepullTest" - - $ref: "#/components/schemas/basepullTestWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - orderWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Order." - createDate: - description: "Create Date for the Order." - modifyDate: - description: "Modify Date for the Order." - orderDate: - description: "Order Date for the Order." - storeId: - type: "integer" - description: "Store Id for the Order." - total: - description: "Total for the Order." - order: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Order. Primary Key." - allOf: - - $ref: "#/components/schemas/orderWithoutPrimaryKey" - orderSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/order" - - $ref: "#/components/schemas/orderWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - orderLineWithoutPrimaryKey: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Order Line." - createDate: - description: "Create Date for the Order Line." - modifyDate: - description: "Modify Date for the Order Line." - orderId: - type: "integer" - description: "Order Id for the Order Line." - lineNumber: - type: "string" - description: "Line Number for the Order Line." - sku: - type: "string" - description: "Sku for the Order Line." - quantity: - type: "integer" - description: "Quantity for the Order Line." - orderLine: - type: "object" - properties: - id: - type: "integer" - description: "Id for the Order Line. Primary Key." - allOf: - - $ref: "#/components/schemas/orderLineWithoutPrimaryKey" - orderLineSearchResult: - type: "object" - properties: - records: - type: "array" - items: - allOf: - - $ref: "#/components/schemas/orderLine" - - $ref: "#/components/schemas/orderLineWithoutPrimaryKey" - allOf: - - $ref: "#/components/schemas/baseSearchResultFields" - responses: - 400: - description: "Bad Request. Some portion of the request's content was not acceptable\ - \ to the server. See error message in body for details." - content: - application/json: - schema: - type: "object" - properties: - error: - type: "string" - example: "Parameter id should be given an integer value, but received\ - \ string: \"Foo\"" - 401: - description: "Unauthorized. The required authentication credentials were missing\ - \ or invalid." - content: - application/json: - schema: - type: "object" - properties: - error: - type: "string" - example: "The required authentication credentials were missing or\ - \ invalid." - 403: - description: "Forbidden. You do not have permission to access the requested\ - \ resource." - content: - application/json: - schema: - type: "object" - properties: - error: - type: "string" - example: "You do not have permission to access the requested resource." - 500: - description: "Internal Server Error. An error occurred in the server processing\ - \ the request." - content: - application/json: - schema: - type: "object" - properties: - error: - type: "string" - example: "Database connection error. Try again later."