Successful Response

APIs.ioEngineeringPlatform

Properties

Name Type Description
data object An object containing the paginated elements.
meta object The response's pagination information.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-gettaggedentities-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getTaggedEntities",
  "title": "Successful Response",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "An object containing the paginated elements.",
      "required": [
        "entities"
      ],
      "properties": {
        "entities": {
          "type": "array",
          "description": "A list of the Postman elements that contain the given tag.",
          "items": {
            "type": "object",
            "properties": {
              "entityId": {
                "type": "string",
                "format": "uid",
                "description": "The element's unique ID.",
                "example": "12345678-6fd634a3-79ba-451d-8f07-56a953f96667"
              },
              "entityType": {
                "enum": [
                  "api",
                  "collection",
                  "workspace"
                ],
                "type": "string",
                "description": "The type of Postman element.",
                "example": "collection"
              }
            }
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "description": "The response's pagination information.",
      "required": [
        "count"
      ],
      "properties": {
        "count": {
          "type": "integer",
          "description": "The number of tagged elements returned in the response.",
          "example": 2
        },
        "nextCursor": {
          "type": "string",
          "format": "base64",
          "description": "The pagination cursor that points to the next record in the results set.",
          "example": "eyJpZCI6ODYsImVudGl0eVR5cGUiOiJhcGkifQ=="
        }
      }
    }
  }
}