admin query api

(Server): Administrative query access (for site implementation)

The current use of the GET method for JSON data exchange is via a JSON query interface. The client can issue queries for specific information about the live, staging, or content-management versions of a Tizra site, by means of the site-specific hostnames. They were originally designed for use by JavaScripts to render dynamic content on public sites.

(Server): Administrative access (via the /admin-api/site-id/query version of the query interface)

Like other administrative operations, the pub-type query parameter is allowed in administrative queries.

The administrative version of the query interface produces a significant amount of additional information, including information about the MetaSource files that make up a document's content and attachments. These fields are "read-only," since source file information is updated separately.

A document record with these additional fields would look like this:

{
	"meta-type": "Book",
	"published-staging": true,
	"name": "10.1.1.157.7899.pdf",
	"props": {
		"BypassToC": "false",
		"Abstract": "",
		"Filename": "",
		"Authors": "",
		"AdminTags": "",
		"UserSetVisibility": "",
		"Keywords": "",
		"AllowPDFDownload": "false",
		"Title": "10.1.1.157.7899.pdf"
	},
	"published-live": true,
	"staging-date": "2013-05-22 16:47:27.046",
	"live-date": "2013-05-22 16:47:27.046",
	"tizra-id": "13mq4",
	"has-unpublished-changes": true,
	"sources": [{
		"name": "PdfSource",
		"is-breakable": true,
		"files": [{
			"size": 243114,
			"name": "10.1.1.157.7899.pdf",
			"content-type": "application\/pdf",
			"url": "\/2009%E2%80%932010\/~~PdfSource\/10.1.1.157.7899.pdf",
			"props": {
				"DisplayName": ""
			},
			"number-of-pages": 20,
			"date-uploaded": "2012-09-28 18:54:09.392"
		}]
	}, {
		"name": "FreeAttachments",
		"is-breakable": false,
		"files": []
	}, {
		"name": "Attachments",
		"is-breakable": false,
		"files": []
	}],
	"url-id": "2009%E2%80%932010"
}

Extra information in this result includes the Sources in the document, along with information about each of the files in each source, the publishing status and relevant dates of the document. It will include an Entity-ID at some point.

This example document has a custom URL containg a Unicode character – (which is %-encoded in UTF-8 as %E2%80%93).