{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/getPanElementsAndFolders",
"title": "Successful Response",
"type": "object",
"properties": {
"elements": {
"description": "Information about a Private API Network's folder elements. Elements are APIs, collections, and workspaces.",
"type": "array",
"items": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the element was created.",
"example": "2020-06-01T08:32:31.000Z"
},
"createdBy": {
"type": "integer",
"description": "The user who created the element.",
"example": 12345678
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the element was last updated.",
"example": "2021-11-29T06:31:24.000Z"
},
"updatedBy": {
"type": "integer",
"description": "The user who updated the element.",
"example": 12345678
},
"addedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the element was published to Private API Network. This value is the same as the `updatedAt` value.",
"example": "2021-11-29T06:31:24.000Z"
},
"addedBy": {
"type": "integer",
"description": "The user ID of the user who published the element.",
"example": 12345678
},
"description": {
"type": "string",
"description": "The element's description.",
"example": "The payments and account services API."
},
"id": {
"type": "string",
"description": "The element's ID.",
"example": "5360b75f-447e-467c-9299-12fd6c92450d"
},
"name": {
"type": "string",
"description": "The element's name.",
"example": "Billing API"
},
"summary": {
"type": "string",
"description": "The element's summary.",
"example": "Payments and Account Services API"
},
"type": {
"type": "string",
"description": "The element's type.",
"example": "api"
},
"parentFolderId": {
"type": "integer",
"description": "The element's parent folder ID.",
"example": 1
},
"href": {
"type": "string",
"format": "url",
"description": "The element's HREF.",
"example": "https://api.getpostman.com/apis/5360b75f-447e-467c-9299-12fd6c92450d"
}
}
}
},
"folders": {
"type": "array",
"description": "Information about the Private API Network's folders.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The folder's ID.",
"example": 1
},
"parentFolderId": {
"type": "integer",
"description": "The folder's parent folder ID.",
"example": 0
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the folder was updated.",
"example": "2021-11-29T06:31:24.000Z"
},
"updatedBy": {
"type": "integer",
"description": "The user ID of the user who updated the folder.",
"example": 12345678
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the folder was created.",
"example": "2020-06-01T08:32:31.000Z"
},
"createdBy": {
"type": "integer",
"description": "The user who created the folder.",
"example": 12345678
},
"name": {
"type": "string",
"description": "The folder's name.",
"example": "Billing"
},
"description": {
"type": "string",
"description": "The folder's description.",
"example": "The Billing API."
},
"type": {
"type": "string",
"description": "The element's type. This value is always `folder`.",
"example": "folder"
}
}
}
},
"meta": {
"type": "object",
"description": "The response's non-standard meta information.",
"properties": {
"limit": {
"type": "integer",
"description": "The maximum number of elements returned. If the value exceeds the maximum value of `1000`, then the system uses the `1000` value.",
"example": 1000
},
"offset": {
"type": "integer",
"example": 0,
"description": "The zero-based offset of the first item returned."
},
"totalCount": {
"type": "integer",
"example": 2,
"description": "The total count of the `elements` and `folders` items."
}
}
}
}
}