assets resource endpoint

URL: /assets/<id>.<format>

This endpoint is the root of information about a specific Asset.

This endpoint is useful if there is a specific asset you want to retrieve information about. If you'd like to list the posts in a blog, see /blogs/<id>/post-assets. Assets are also often found via Event objects retrieved from the various event stream endpoints in the API. You can also do full-text searches of assets across the whole of TypePad via the endpoint /assets.

New assets are created by submitting a POST request to an asset listing endpoint which depends on what context you wish to create the asset in. To create a new post in a blog, see /blogs/<id>/post-assets. To upload a media asset to use within a blog post, see /blogs/<id>/media-assets. To post a comment in response to another asset, see /assets/<id>/comments. The type of asset created depends on the context in which you POST it and, in some cases, on the data you provide in the request.





Supported Methods

DELETE Delete the selected asset and its associated events, comments and favorites.
GET Get basic information about the selected asset.
PUT Update the selected asset.

Resource Type

This endpoint returns an object of type Asset.

author (User)
(Read Only) The user who created the selected asset.
commentCount (integer)
(Read Only) The number of comments that have been posted in reply to this asset. This number includes comments that have been posted in response to other comments.
container (ContainerRef)
(Read Only) An object describing the group or blog to which this asset belongs.
content (string)
The raw asset content. The textFormat property describes how to format this data. Use this property to set the asset content in write operations. An asset posted in a group may have a content value up to 10,000 bytes long, while a Post asset in a blog may have up to 65,000 bytes of content.
crosspostAccounts (set<string>)
(Write Only) A set of identifiers for Account objects to which to crosspost this asset when it's posted. This property is omitted when retrieving existing assets.
description (string)
The description of the asset.
excerpt (string)
(Read Only) A short, plain-text excerpt of the entry content. This is currently available only for Post assets.
favoriteCount (integer)
(Read Only) The number of distinct users who have added this asset as a favorite.
groups (array<string>)
(Read Only) (Deprecated) An array of strings containing the id URI of the Group object that this asset is mapped into, if any. This property has been superseded by the container property.
hasExtendedContent (boolean)
(Read Only) true if this asset has the extended content. This is currently supported only for Post assets that are posted within a blog.
id (string)
(Read Only) A URI that serves as a globally unique identifier for the user.
isFavoriteForCurrentUser (boolean)
(Read Only) true if this asset is a favorite for the currently authenticated user, or false otherwise. This property is omitted from responses to anonymous requests.
negativeVoteCount (integer)
(Read Only) The total number of negative votes this asset has received via the /assets/<id>/cast-negative-vote endpoint.
objectType (string)
(Read Only) The keyword identifying the type of asset this is.
objectTypes (set<string>)
(Read Only) (Deprecated) An array of object type identifier URIs identifying the type of this asset. Only the one object type URI for the particular type of asset this asset is will be present.
permalinkUrl (string)
(Read Only) The URL that is this asset's permalink. This will be omitted if the asset does not have a permalink of its own (for example, if it's embedded in another asset) or if TypePad does not know its permalink.
positiveVoteCount (integer)
(Read Only) The total number of positive votes this asset has received via the /assets/<id>/cast-positive-vote endpoint.
publicationStatus (PublicationStatus)
An object describing the visibility status and publication date for this asset. Only visibility status is editable.
published (datetime)
(Read Only) The time at which the asset was created, as a W3CDTF timestamp.
reblogOf (AssetRef)
(Read Only) (Deprecated) If this asset was created by 'reblogging' another asset, this property describes the original asset.
reblogOfUrl (string)
(Read Only) (Deprecated) If this asset was created by 'reblogging' another asset or some other arbitrary web page, this property contains the URL of the item that was reblogged.
renderedContent (string)
(Read Only) The content of this asset rendered to HTML. This is currently available only for Post and Page assets.
shortUrl (string)
(Read Only) The short version of the URL that is this asset's permalink. This is currently available only for Post assetes.
source (AssetSource)
(Read Only) An object describing the site from which this asset was retrieved, if the asset was obtained from an external source.
textFormat (string)
A keyword that indicates what formatting mode to use for the content of this asset. This can be html for assets the content of which is HTML, html_convert_linebreaks for assets the content of which is HTML but where paragraph tags should be added automatically, or markdown for assets the content of which is Markdown source. Other formatting modes may be added in future. Applications that present assets for editing should use this property to present an appropriate editor.
title (string)
The title of the asset.
urlId (string)
(Read Only) A string containing the canonical identifier that can be used to identify this object in URLs. This can be used to recognise where the same user is returned in response to different requests, and as a mapping key for an application's local data store.

Client Library Methods for PHP

Delete the selected asset and its associated events, comments and favorites.
$tp->assets->delete(array(

    # Required Parameters
    "id" => $id,

))
Get basic information about the selected asset.
$tp->assets->get(array(

    # Required Parameters
    "id" => $id,

))
Update the selected asset.
$tp->assets->put(array(

    # Required Parameters
    "id" => $id,
    "payload" => $payload,

))

Property Endpoints

This endpoint has the following property endpoints:

favorites Get a list of favorites that have been created for the selected asset.
categories Get a list of categories into which this asset has been placed within its blog. Currently supported only for Post assets that are posted within a blog.
publication-status Get the publication status of the selected asset.
reblogs Get a list of posts that were posted as reblogs of the selected asset.
comments Get a list of assets that were posted in response to the selected asset.
comment-tree Get a list of assets that were posted in response to the selected asset and their depth in the response tree
extended-content Get the extended content for the asset, if any. Currently supported only for Post assets that are posted within a blog.
feedback-status Get the feedback status of the selected asset.
media-assets Get a list of media assets that are embedded in the content of the selected asset.

Action Endpoints

This endpoint has the following action endpoints:

cast-negative-vote Send a negative vote/thumbs up for an asset.
cast-positive-vote Send a positive vote/thumbs up for an asset.
remove-category Send label argument to remove a category from an asset
add-category Send label argument to add a category to an asset
update-publication-status Adjust publication status of an asset
make-comment-preview Send relevant data to get back a model of what the submitted comment will look like.

Example Request

GET /assets/6a012877b13de7970c012877b143d0970c.json HTTP/1.1
Host: api.typepad.com

HTTP/1.0 200 OK
Content-type: application/json
Content-length: 2292

{
   "excerpt": "I've started this blog to share interesting law facts and information about cases I find interesting. Information in this blog is not legal advice.",
   "embeddedAudioLinks": [],
   "content": "<p>I've started this blog to share interesting law facts and information about cases I find interesting.</p>\r\n<p>Information in this blog is not legal advice.</p>",
   "reblogCount": 0,
   "favoriteCount": 2,
   "author": {
      "urlId": "6p012877b13de7970c",
      "location": null,
      "interests": [],
      "objectTypes": [
         "tag:api.typepad.com,2009:User"
      ],
      "profilePageUrl": "http://profile.typepad.com/loblawatlaw",
      "aboutMe": null,
      "objectType": "User",
      "preferredUsername": "loblawatlaw",
      "id": "tag:api.typepad.com,2009:6p012877b13de7970c",
      "avatarLink": {
         "width": 250,
         "urlTemplate": "http://static.typepad.com/.shared:v0b82da1:typepad:en_us/default-userpics/11-{spec}.gif",
         "url": "http://static.typepad.com/.shared:v0b82da1:typepad:en_us/default-userpics/11-250si.gif",
         "height": 250
      },
      "displayName": "Bob Loblaw"
   },
   "renderedContent": "<p>I've started this blog to share interesting law facts and information about cases I find interesting.</p>\r\n<p>Information in this blog is not legal advice.</p>",
   "hasExtendedContent": false,
   "objectType": "Post",
   "groups": [],
   "id": "tag:api.typepad.com,2009:6a012877b13de7970c012877b143d0970c",
   "embeddedVideoLinks": [],
   "urlId": "6a012877b13de7970c012877b143d0970c",
   "objectTypes": [
      "tag:api.typepad.com,2009:Post"
   ],
   "categories": [],
   "container": {
      "urlId": "6a012877b13de7970c012877b13df1970c",
      "objectType": "Blog",
      "id": "tag:api.typepad.com,2009:6a012877b13de7970c012877b13df1970c",
      "homeUrl": "http://bobloblaw.typepad.com/blog/",
      "displayName": "Bob Loblaw Law Blog"
   },
   "description": "",
   "commentCount": 2,
   "published": "2010-02-18T00:02:56Z",
   "textFormat": "html",
   "permalinkUrl": "http://bobloblaw.typepad.com/blog/2010/02/welcome-t.html",
   "embeddedImageLinks": [],
   "filename": "welcome-t",
   "shortUrl": "http://bit.ly/aj4Deb",
   "title": "Welcome to my Blog"
}