Download OpenAPI specification:Download
The Quant Content API allows you to manage your published assets programmatically
Returns a list of published assets
| quant_type | string Enum: "content" "redirect" "file" Filter by asset type |
| published | boolean Filter by published state |
| deleted | boolean Filter by deleted state |
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
| Quant-Url | string Optionally limit to a single URL |
{- "global_meta": {
- "records": [
- {
- "last_modified": "string",
- "meta": {
- "url": "string",
- "type": "string",
- "seq_num": 0,
- "published": true,
- "published_revision": 0,
- "published_md5": "string",
- "byte_length": 0,
- "revision_count": 0,
- "highest_revision_number": 0,
- "deleted": true,
- "deleted_timestamp": 0,
- "md5": "string",
- "revision_number": 0,
- "date_timestamp": 0
}
}
]
}, - "total_records": 1000,
- "total_pages": 1,
- "page": 1,
- "page_size": 10,
- "refine_search": false
}Returns a list of assets by query
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
| Quant-Url required | Array of any List of URLs to retrieve meta for. |
{- "Quant-Url": [
- "/home",
- "/css/styles.css",
- "/contact-us"
]
}{- "global_meta": {
- "records": [
- {
- "last_modified": "string",
- "meta": {
- "url": "string",
- "type": "string",
- "seq_num": 0,
- "published": true,
- "published_revision": 0,
- "published_md5": "string",
- "byte_length": 0,
- "revision_count": 0,
- "highest_revision_number": 0,
- "deleted": true,
- "deleted_timestamp": 0,
- "md5": "string",
- "revision_number": 0,
- "date_timestamp": 0
}
}
]
}
}Returns a list of revisions for a given asset
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
{- "revisions": { },
- "url": "string",
- "published": true,
- "published_revision": 0,
- "transitions": [
- {
- "state": "published",
- "date_timestamp": 0
}
], - "highest_revision_number": 0,
- "transition_revision": 0
}Returns metadata for a given revision
| revision required | integer Enum: "first" "last" "published" "revision_id" May be special key (first|last|published) or the specific revision id |
| include_content required | query Default: true Control whether content is returned in the response |
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
{- "md5": "string",
- "type": "string",
- "byte_length": 0,
- "revision_number": 0,
- "date_timestamp": 0,
- "deleted": true,
- "deleted_timestamp": 0,
- "transitions": [
- {
- "state": "published",
- "date_timestamp": 0
}
], - "info": {
- "author_user": "string",
- "author_name": "string",
- "author_email": "string",
- "log": "string",
- "custom_1": "string",
- "custom_2": "string",
- "source": "string"
}
}Create content or file revision
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
| Quant-File-Url | string Required for binary file uploads only |
| url required | string <= 4096 characters The content URL. Must be relative and start with a leading '/' |
| content required | string The content (e.g. html) |
| published required | boolean If the asset should be published |
| content_timestamp | integer User defined timestamp for this content item |
object (Info) Metadata stored with this revision | |
Array of objects (Transition) List of transitions |
{- "url": "string",
- "content": "string",
- "published": true,
- "content_timestamp": 0,
- "info": {
- "author_user": "string",
- "author_name": "string",
- "author_email": "string",
- "log": "string",
- "custom_1": "string",
- "custom_2": "string",
- "source": "string"
}, - "transitions": [
- {
- "state": "published",
- "date_timestamp": 0
}
]
}Create a redirect
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
| url required | string The redirect from URL |
| redirect_url required | string The destination URL |
| redirect_http_code required | integer The HTTP code to send with the redirect |
| published required | boolean If the redirect is published |
| content_timestamp | integer User defined timestamp for this content item |
object (Info) Metadata stored with this revision | |
Array of objects (Transition) List of transitions |
{- "url": "string",
- "redirect_url": "string",
- "redirect_http_code": 301,
- "published": true,
- "content_timestamp": 0,
- "info": {
- "author_user": "string",
- "author_name": "string",
- "author_email": "string",
- "log": "string",
- "custom_1": "string",
- "custom_2": "string",
- "source": "string"
}, - "transitions": [
- {
- "state": "published",
- "date_timestamp": 0
}
]
}Delete an asset revision
| revision required | integer The revision to delete |
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
| Quant-Url required | string The url to the asset |
Create or update items in search index
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |
| Quant-Project required | string The project machine name |
| title | string The title of a search record |
| content | string The full body of content related to a search record |
| url | string The URL of a search record |
| summary | string The optional summary of a search record |
[- {
- "title": "string",
- "content": "string",
- "url": "string",
- "summary": "string"
}
]Ping the server to verify credentials for a given project. Returns basic project detail and configuration
| Quant-Customer required | string The customer account name |
| Quant-Project required | string The project machine name |