The format for all system plug-ins in the feeds
collection matches the following example.
<name>InfoSphere MashupHub Search Feed</name>
<title type="text">Entry Finance Spreadsheet</title>
<summary>Finances for Q1-2008</summary>
<link rel="self" href="http://localhost/mashuphub/client/app/entry/objectid/11"/>
<link rel="edit" href="http://localhost/mashuphub/client/app/entry/objectid/11"/>
<catalog:description>Finances for Q1-2008</catalog:description>
<catalog:metadata name="Approval" label="Approval"
value="Approved for External"/>
label="Deployment Type" value="Production"/>
If this had been an example of an Internet or an intranet feed that had been registered in MashupHub an additional element <url>
would have been included, such as <url>www.somenewsorg.com/feed</url>
The child elements of <entry>
follow the standard Atom feed format. The self
link provides the URL for fetching this entry. The edit link provides the URL for posting changes to the entry.
The child elements of the <content>
element are the following:
The version number of the feed in the form x.y.z where x, y and z are any integer values.author
The user ID of the user who registered or created this feed.name
The descriptive name of the feed. Its maximum length is 200 characters.description
A text description of the feed. Its maximum length is 1000 characters.rating
A decimal value from 1 to 5, inclusive, that indicates the average user rating of this feed. downloads
An integer value representing the number of times this feed has been viewed through the catalog user interface.useCount
An integer value representing the number of times the feed has been accessed, including views or MashupHub Publishing Protocol operations.numComments
The integer value of the number of comments that have been posted to the catalog entry for this feed.downloadURL
The URL endpoint of the feed. Its maximum length is 2048 characters.permalink
The permalink for the object in the catalog. The permanent link that points to a specific Mashup Center object. Users can bookmark the permalink to access the details page of the object directly.
For registered feeds (feeds registered from internet or intranet syndication sites), this element is included in the feed. Its value is the URL of the source feed. The value of url differs from downloadURL since MashupHub proxies the registered feed. Through the catalog API, you can use url to supply the URL of the feed to be registered.tags
This is a container element for the set of social tags that describe this feed. tags/tag
A user defined tag for this feed. Maximum length is 50 characters. If the feed has not been tagged, the tags element will be empty.categories
This is a container element for the set of categories by which this feed is classified.categories/category
Administrator defined, user assigned category for this feed. Maximum length is 100 characters. If the feed has not been categorized, the categories element will be empty.documentationURL
A URL that points to documentation for the feed, such as a microformat page. This value is optional.permission
A string representing the permission that applies to this object. The possible values are:
- pubic – all users can read the object and its metadata.
- private – only the creator can read the object and its metadata and change the object.
- custom – an access control list specifies view and edit permissions for the object.
A set of metadata items assigned to this entry.objectmeta/metadata
A metadata item assigned to the entry by the administrator. It requires three attributes, name, label and value.
The name of the metadata item as assigned by the administrator. The maximum length is 200 characters.label
The label used for this metadata item in the catalog user interface. The maximum length is 200 characters.value
The metadata value assigned to the entry by the administrator. The maximum length is 2048 characters.
When registering a new feed or editing the metadata of a feed in the catalog the Atom entry should look like the above example. When the operation is complete, MashupHub will assign the ID for the entry and respond with the entry as it was entered into the collection. More information about updating the catalog through these Atom Publishing Protocol (APP) feeds is presented in the Catalog API
Parent topic: Atom format: imc3