Request Message List Parameters

APIs.ioEngineeringPlatform

Properties

Name Type Description
after object
before object
page integer Page number of results
per_page integer Number of results per page
sort_by string Field to sort results by
sort_order string Sort order (asc or desc)
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-cloudforce-one-request-message-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/cloudforce-one_request-message-list",
  "title": "Request Message List Parameters",
  "properties": {
    "after": {
      "allOf": [
        {
          "$ref": "#/components/schemas/cloudforce-one_time"
        },
        {
          "description": "Retrieve messages created after this time"
        },
        {
          "example": "2022-01-01T00:00:00Z"
        }
      ]
    },
    "before": {
      "allOf": [
        {
          "$ref": "#/components/schemas/cloudforce-one_time"
        },
        {
          "description": "Retrieve messages created before this time"
        },
        {
          "example": "2024-01-01T00:00:00Z"
        }
      ]
    },
    "page": {
      "description": "Page number of results",
      "type": "integer"
    },
    "per_page": {
      "description": "Number of results per page",
      "example": 10,
      "type": "integer"
    },
    "sort_by": {
      "description": "Field to sort results by",
      "example": "created",
      "type": "string"
    },
    "sort_order": {
      "description": "Sort order (asc or desc)",
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string"
    }
  },
  "required": [
    "page",
    "per_page"
  ],
  "type": "object"
}