Skip to content

GET meta object api

Aron Griffis edited this page May 11, 2017 · 2 revisions

(Server) GET for Tizra objects

Separate pages document the details of specific objects, but anything that has a tizra-id can be described by a GET operation to its admin URL. (e.g. /admin-api/<site>/objects/<tizra-id>).

For example a book might return:

{
    "has-unpublished-changes": false, 
    "is-free": false, 
    "live-date": "2014-07-21 06:19:41.852", 
    "meta-type": "Book", 
    "name": "King Richard III", 
    "props": {
        "Abstract": "<p>A Royal play</p>\n", 
        "AdminTags": [
            "drama"
        ], 
        "AllowPDFDownload": "true", 
        "Authors": [
            "William Shakespeare"
        ], 
        "BypassToC": "false", 
        "Chapter": "", 
        "Collection": "", 
        "CoverURL": "", 
        "Filename": "", 
        "ISBN": "1234567890", 
        "Keywords": [
            "Machine Musicianship"
        ], 
        "Program": "", 
        "Title": "King Richard III", 
        "product-codes": [], 
        "test": "false", 
        "testFlags": [], 
        "testHTML": "", 
        "video": ""
    }, 
    "published-live": true, 
    "published-staging": true, 
    "sources": [
        {
            "files": [
                {
                    "content-type": "application/binary", 
                    "date-uploaded": "2014-02-27 19:06:15.151", 
                    "name": "determinism-vldb10.pdf", 
                    "number-of-pages": 11, 
                    "props": {
                        "DisplayName": "", 
                        "lang": "EN", 
                        "rel": "", 
                        "test-prop": "test-value"
                    }, 
                    "size": 544815, 
                    "url": "/1pp8n/~~PdfSource/determinism-vldb10.pdf"
                }
            ], 
            "is-breakable": true, 
            "name": "PdfSource"
        }, 
        {
            "files": [], 
            "is-breakable": false, 
            "name": "FreeAttachments"
        }, 
        {
            "files": [], 
            "is-breakable": false, 
            "name": "Attachments"
        }
    ], 
    "staging-date": "2014-07-21 06:19:41.852", 
    "tizra-id": "1pp8n", 
    "url-id": "1pp8n"
}

A collection might return something like this:

{
    "all-query": "", 
    "any-query": "AdminTagged:AdminTags:katmakaram-1;snaish flyshar", 
    "excluding": null, 
    "has-unpublished-changes": true, 
    "is-free": false, 
    "live-date": "2013-12-02 17:26:05.665", 
    "meta-type": "SubjectCollection", 
    "name": "hyphen testing", 
    "props": {
        "AdminTags": [], 
        "Description": "", 
        "Name": "hyphen testing", 
        "Tizra-customUrl": "", 
        "autotest": "", 
        "hwp-id": "/dup/book/atom?scheme=products&term=2008"
    }, 
    "published-live": true, 
    "published-staging": true, 
    "sources": [], 
    "staging-date": "2013-12-02 17:26:05.665", 
    "tizra-id": "1jkoj", 
    "url-id": "1jkoj"
}