Networking

Retrieve Network site document

Retrieve a single network site document by ID. Partner-scoped.

get/admin/networking/network-sites-documents/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/networking/network-sites-documents/{id}
  • Auth: HTTP basic

Path parameters

idinteger required
Example:10

Document primary key.

Response

idinteger

Document ID (primary key).

typestring

Document type identifier used by the download endpoint.

hash_idstring

32-character random hash used by the public download URL.

filename_originalstring

Original filename as uploaded by the client.

filename_uploadedstring

Stored filename on disk.

download_linkstring

Relative admin download URL for the file.

has_thumbnailboolean

True if a thumbnail preview is available on disk for this document.

sizeinteger

File size in bytes.

thumbnail_linkstring

Relative URL to the thumbnail; empty string when has_thumbnail is false.

Example response

{
  "id": 10,
  "type": "networking_network_sites_documents",
  "hash_id": "c325fc52f5c4fe31f0940384599aafb2",
  "filename_original": "site_blueprint.pdf",
  "filename_uploaded": "c0adc27c4f4b1dfe",
  "download_link": "/admin/download?module=networking_network_sites_documents&id=10",
  "size": 228
}

Changes

No recorded changes to this operation across all 1 revision of this API.