-
Notifications
You must be signed in to change notification settings - Fork 0
Meta Types
Aron Griffis edited this page Aug 27, 2018
·
4 revisions
Tizra objects have a type system, which is hierarchical. Subtypes in the type hierarchy inherit property and metasource definitions from the parent properties. It is possible to manage Tizra Metatypes directly, but
You would want to use the beta of the meta-type api...
For instance you could (and I have done things like this).
To Add "Figures" to Excerpts, you would want to POST something like this:
{ "meta-sources": "Figures", "Figures Attachment Area", "data" }
to: https://secure.agilepdf.com/admin-api/3fqo4e/types/PageRange
GET to https://secure.agilepdf.com/admin-api/3fqo4e/types will get you current information on type names.
Get to https://secure.agilepdf.com/admin-api/3fqo4e/types/PageRange will get you info on that type.
If you wanted Book-level Illustrations or data supplements you would post to https://secure.agilepdf.com/admin-api/3fqo4e/types/Book
Documentation will follow when the interface is complete. You will be able to alter properties and so on (as well as create new types), once the whole interface is complete, but some of those facilities will take a while yet. Updating properties will come pretty soon though.
Tizra properties are stored as strings, but are specified for certain data and interface types. The list of types used is as follows:
- integer
- integer-list
- string
- string-list
- date
- date-list
- boolean
- boolean-list
- float
- float-list
- reference not used
- reference-list not used
- keyword
- keyword-list
- encrypted-url ** for amazon streaming content **
- html
- text
- css-color
- auto-uuid
- isbn
- isbn13
- json-array
- json-hash
- json-value
All list types are represented by semicolon-separated strings internally, the JSOn APIs return list format properties as JSON Arrays rather than encoded strings.
Some obsolete metaTypes have been removed from this example of a JSON type-info return. Also a variety of non-standard optional properties have been removed, but not all.
{
"PdfPage": {
"name": "PdfPage",
"display-name": "Pdf Page",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": ["PdfPage"]
},
"Book": {
"name": "Book",
"display-name": "Book",
"tag-definitions": {
"BypassToC": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "BypassToC",
"name": "BypassToC",
"css-class": "bypasstoc",
"is-system": true,
"is-user-visible": false,
"display-name": "Bypass ToC",
"type": "boolean"
},
"Abstract": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Abstract",
"name": "Abstract",
"css-class": "abstract",
"is-system": true,
"is-user-visible": false,
"display-name": "Abstract",
"type": "html"
},
"Authors": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "Authors",
"name": "Authors",
"css-class": "authors",
"is-system": true,
"is-user-visible": false,
"display-name": "Authors",
"type": "string-list"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"UserSetVisibility": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "UserSetVisibility",
"name": "UserSetVisibility",
"css-class": "usersetvisibility",
"is-system": true,
"is-user-visible": false,
"display-name": "User Set Visibility",
"type": "string-list"
},
"Keywords": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "Keywords",
"name": "Keywords",
"css-class": "keywords",
"is-system": true,
"is-user-visible": false,
"display-name": "Keywords",
"type": "string-list"
},
"AllowPDFDownload": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "AllowPDFDownload",
"name": "AllowPDFDownload",
"css-class": "allowpdfdownload",
"is-system": true,
"is-user-visible": false,
"display-name": "Allow PDF Download",
"type": "boolean"
},
"test": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "",
"name": "test",
"css-class": "test",
"is-system": false,
"is-user-visible": true,
"display-name": "test",
"type": "boolean"
},
"testFlags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "time",
"name": "testFlags",
"css-class": "testflags",
"is-system": false,
"is-user-visible": false,
"display-name": "testFlags",
"type": "boolean-list"
},
"Title": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Title",
"name": "Title",
"css-class": "title",
"is-system": true,
"is-user-visible": false,
"display-name": "Title",
"type": "string"
},
},
"parent-type-name": "Title",
"meta-source-names": ["PdfSource", "Attachments"]
},
"VirtualCollection": {
"name": "VirtualCollection",
"display-name": "Virtual Collection",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"Name": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Name",
"name": "Name",
"css-class": "name",
"is-system": true,
"is-user-visible": false,
"display-name": "Name",
"type": "string"
}
},
"parent-type-name": "SubjectCollection",
"meta-source-names": []
},
"SubjectCollection": {
"name": "SubjectCollection",
"display-name": "Collection",
"tag-definitions": {
"Abstract": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "",
"name": "Abstract",
"css-class": "abstract",
"is-system": false,
"is-user-visible": true,
"display-name": "Abstract",
"type": "html"
},
"Title": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "",
"name": "Title",
"css-class": "title",
"is-system": false,
"is-user-visible": true,
"display-name": "Title",
"type": "text"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"Name": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Name",
"name": "Name",
"css-class": "name",
"is-system": true,
"is-user-visible": false,
"display-name": "Name",
"type": "string"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": []
},
"PageRange": {
"name": "PageRange",
"display-name": "Excerpt",
"tag-definitions": {
"BypassToC": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "BypassToC",
"name": "BypassToC",
"css-class": "bypasstoc",
"is-system": true,
"is-user-visible": false,
"display-name": "Bypass ToC",
"type": "boolean"
},
"Authors": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "",
"name": "Authors",
"css-class": "authors",
"is-system": false,
"is-user-visible": true,
"display-name": "Excerpt Authors",
"type": "keyword-list"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"DownloadVersion": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "DownloadVersion",
"name": "DownloadVersion",
"css-class": "downloadversion",
"is-system": true,
"is-user-visible": false,
"display-name": "DownloadVersion",
"type": "string"
},
"AllowPDFDownload": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "AllowPDFDownload",
"name": "AllowPDFDownload",
"css-class": "allowpdfdownload",
"is-system": true,
"is-user-visible": false,
"display-name": "Allow PDF Download",
"type": "boolean"
},
"Title": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Title",
"name": "Title",
"css-class": "title",
"is-system": true,
"is-user-visible": false,
"display-name": "Title",
"type": "string"
},
},
"parent-type-name": "AdminTagged",
"meta-source-names": ["Attachments"]
},
"UserData": {
"name": "UserData",
"display-name": "User Data",
"tag-definitions": {
"LastName": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "LastName",
"name": "LastName",
"css-class": "lastname",
"is-system": true,
"is-user-visible": false,
"display-name": "Last Name",
"type": "string"
},
"Zip": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "5",
"name": "Zip",
"css-class": "zip",
"is-system": false,
"is-user-visible": false,
"display-name": "Zip",
"type": "integer"
},
"Street": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "1",
"name": "Street",
"css-class": "street",
"is-system": false,
"is-user-visible": false,
"display-name": "Street",
"type": "string"
},
"CountryCode": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "00",
"name": "CountryCode",
"css-class": "countrycode",
"is-system": false,
"is-user-visible": true,
"display-name": "Country",
"type": "keyword"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"City": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "3",
"name": "City",
"css-class": "city",
"is-system": false,
"is-user-visible": false,
"display-name": "City",
"type": "keyword-list"
},
"Street2": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "2",
"name": "Street2",
"css-class": "street2",
"is-system": false,
"is-user-visible": false,
"display-name": "Street2",
"type": "string"
},
"Province": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "6",
"name": "Province",
"css-class": "province",
"is-system": false,
"is-user-visible": false,
"display-name": "Province",
"type": "keyword-list"
},
"State": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "5",
"name": "State",
"css-class": "state",
"is-system": false,
"is-user-visible": false,
"display-name": "State",
"type": "string"
},
"FirstName": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": true,
"sort-field": "FirstName",
"name": "FirstName",
"css-class": "firstname",
"is-system": true,
"is-user-visible": false,
"display-name": "First Name",
"type": "string"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": []
},
"Title": {
"name": "Title",
"display-name": "Document",
"tag-definitions": {
"Abstract": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Abstract",
"name": "Abstract",
"css-class": "abstract",
"is-system": true,
"is-user-visible": false,
"display-name": "Abstract",
"type": "html"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"AllowPDFDownload": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "AllowPDFDownload",
"name": "AllowPDFDownload",
"css-class": "allowpdfdownload",
"is-system": true,
"is-user-visible": false,
"display-name": "Allow PDF Download",
"type": "boolean"
},
"BypassToC": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "BypassToC",
"name": "BypassToC",
"css-class": "bypasstoc",
"is-system": true,
"is-user-visible": false,
"display-name": "Bypass ToC",
"type": "boolean"
},
"Keywords": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "Keywords",
"name": "Keywords",
"css-class": "keywords",
"is-system": true,
"is-user-visible": false,
"display-name": "Keywords",
"type": "string-list"
},
"Title": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Title",
"name": "Title",
"css-class": "title",
"is-system": true,
"is-user-visible": false,
"display-name": "Title",
"type": "string"
},
"UserSetVisibility": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": false,
"sort-field": "UserSetVisibility",
"name": "UserSetVisibility",
"css-class": "usersetvisibility",
"is-system": true,
"is-user-visible": false,
"display-name": "User Set Visibility",
"type": "string-list"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": ["PdfSource", "Attachments"]
},
"Image": {
"name": "Image",
"display-name": "Image",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"Description": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Description",
"name": "Description",
"css-class": "description",
"is-system": true,
"is-user-visible": false,
"display-name": "Description",
"type": "string"
},
"Title": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Title",
"name": "Title",
"css-class": "title",
"is-system": true,
"is-user-visible": false,
"display-name": "Title",
"type": "string"
},
"Tizra-customUrl": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Tizra-customUrl",
"name": "Tizra-customUrl",
"css-class": "tizracustomurl",
"is-system": true,
"is-user-visible": false,
"display-name": "Custom URL",
"type": "keyword"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": ["ImageSource"]
},
"AdminTagged": {
"name": "AdminTagged",
"display-name": "Any Type",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"Tizra-customUrl": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Tizra-customUrl",
"name": "Tizra-customUrl",
"css-class": "tizracustomurl",
"is-system": true,
"is-user-visible": false,
"display-name": "Custom URL",
"type": "keyword"
}
},
"meta-source-names": []
},
"SiteDisplay": {
"name": "SiteDisplay",
"display-name": "Home Page",
"tag-definitions": {
"supportOldMarkup": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "",
"name": "supportOldMarkup",
"css-class": "supportoldmarkup",
"is-system": false,
"is-user-visible": false,
"display-name": "supportOldMarkup",
"type": "boolean"
},
"siteCartUrl": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "ZZZZ",
"name": "siteCartUrl",
"css-class": "sitecarturl",
"is-system": false,
"is-user-visible": false,
"display-name": "Site Shopping Cart URL",
"type": "string"
},
"defaultUserImportFormat": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "",
"name": "defaultUserImportFormat",
"css-class": "defaultuserimportformat",
"is-system": false,
"is-user-visible": false,
"display-name": "defaultUserImportFormat",
"type": "text"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": []
},
"VirtualCollectionDefinition": {
"name": "VirtualCollectionDefinition",
"display-name": "Virtual Collection",
"tag-definitions": {
"time": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "",
"name": "time",
"css-class": "time",
"is-system": false,
"is-user-visible": false,
"display-name": "time",
"type": "string"
},
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"Name": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Name",
"name": "Name",
"css-class": "name",
"is-system": true,
"is-user-visible": false,
"display-name": "Name",
"type": "string"
}
},
"parent-type-name": "SubjectCollection",
"meta-source-names": []
},
"Offer": {
"name": "Offer",
"display-name": "Offer",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"pdfDownLoadAllowed": {
"is-searchable": false,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "pdfDownLoadAllowed",
"name": "pdfDownLoadAllowed",
"css-class": "pdfdownloadallowed",
"is-system": true,
"is-user-visible": false,
"display-name": "Allow Pdf Downloads",
"type": "boolean"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": []
},
"StaticPage": {
"name": "StaticPage",
"display-name": "Static Page",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"StaticText": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "StaticText",
"name": "StaticText",
"css-class": "statictext",
"is-system": true,
"is-user-visible": false,
"display-name": "Static Text",
"type": "string"
},
"Title": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Title",
"name": "Title",
"css-class": "title",
"is-system": true,
"is-user-visible": false,
"display-name": "Title",
"type": "string"
}
},
"parent-type-name": "AdminTagged",
"meta-source-names": []
},
"VirtualCollectionInstance": {
"name": "VirtualCollectionInstance",
"display-name": "Virtual Collection",
"tag-definitions": {
"AdminTags": {
"is-searchable": true,
"is-list-type": true,
"is-user-defined": true,
"sort-field": "AdminTags",
"name": "AdminTags",
"css-class": "admintags",
"is-system": true,
"is-user-visible": false,
"display-name": "Tags 3",
"type": "keyword-list"
},
"Name": {
"is-searchable": true,
"is-list-type": false,
"is-user-defined": false,
"sort-field": "Name",
"name": "Name",
"css-class": "name",
"is-system": true,
"is-user-visible": false,
"display-name": "Name",
"type": "string"
}
},
"parent-type-name": "SubjectCollection",
"meta-source-names": []
}
}