Element Created

Information about the Private API Network element.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
addedAt	string	The date and time at which the element was added.
addedBy	integer	The user who added the element.
createdBy	integer	The user who created the element.
createdAt	string	The date and time at which the element was created.
updatedBy	integer	The user who last updated the element.
updatedAt	string	The date and time at which the element was last updated.
type	string	The element's type.
id	string	The element's ID or UID.
name	string	The element's name.
summary	string	The element's summary.
description	string	The element's description.
href	string	The element's Postman URL.
parentFolderId	integer	The parent folder's ID.
environments	array	A list of the element's environments.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/panElementCreated",
  "title": "Element Created",
  "description": "Information about the Private API Network element.",
  "type": "object",
  "properties": {
    "addedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the element was added.",
      "example": "2022-06-09T14:48:45.000Z"
    },
    "addedBy": {
      "type": "integer",
      "description": "The user who added the element.",
      "example": 12345678
    },
    "createdBy": {
      "type": "integer",
      "description": "The user who created the element.",
      "example": 12345678
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the element was created.",
      "example": "2021-10-11T09:39:33.000Z"
    },
    "updatedBy": {
      "type": "integer",
      "description": "The user who last updated the element.",
      "example": 12345678
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the element was last updated.",
      "example": "2022-12-07T17:54:33.000Z"
    },
    "type": {
      "type": "string",
      "description": "The element's type.",
      "example": "api"
    },
    "id": {
      "type": "string",
      "description": "The element's ID or UID.",
      "example": "5360b75f-447e-467c-9299-12fd6c92450d"
    },
    "name": {
      "type": "string",
      "description": "The element's name.",
      "example": "Billing API"
    },
    "summary": {
      "type": "string",
      "nullable": true,
      "description": "The element's summary.",
      "example": "The payments and account services API."
    },
    "description": {
      "type": "string",
      "description": "The element's description.",
      "example": ""
    },
    "href": {
      "type": "string",
      "format": "url",
      "description": "The element's Postman URL.",
      "example": "https://api.getpostman.com/collections/12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
    },
    "parentFolderId": {
      "type": "integer",
      "description": "The parent folder's ID.",
      "example": 1
    },
    "environments": {
      "type": "array",
      "description": "A list of the element's environments.",
      "items": {
        "type": "string",
        "example": "120403-c6cf0fe2-c637-4d30-a640-ed64ec6d0ddb"
      }
    }
  }
}