Parameters Get

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description": "Change the number of results returned."
    },
    "offset": {
      "type": "integer"
    },
    "order_by": {
      "type": "object"
    },
    "page": {
      "type": "integer",
      "description": "Paginate through results."
    },
    "sort": {
      "description": "Define sort order.",
      "type": "object"
    },
    "sourceId": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    },
    "sourceName": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sourceSlug": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "meta": {
      "type": "object"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "displayName",
          "description",
          "preferredUnit"
        ],
        "properties": {
          "description": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "id": {
            "type": "integer"
          },
          "isCore": {
            "type": "boolean"
          },
          "maxColorValue": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "preferredUnit": {
            "type": "string"
          }
        }
      }
    }
  }
}