Retrieve the Blogs service document 

Before your applications can create or update information in a blog, retrieve the service document. You can use the links that it provides to locate the resources that you want to update.

Table 1. Atom API request details

Method	Resource	URI	Description
GET	Service document	/api	Accesses a user's service document. The service document provides a list of workspaces, one for each blog the user owns or for which the user is an author. It also provides a workspace for the My Blogs collection, which was introduced in version 2.0.
GET	Service document	/services/atom	Accesses a user's service document. The service document provides a list of workspaces, one for each blog the user owns or for which the user is an author. This service document is compatible with IBM Connections version 1.0.x. It does not provide a workspace for the My Blogs collection.

Input parameters

None.

Output

A Blogs service document in Atom Publishing protocol format.

The following HTTP headers:

• HTTP/1.1 200 OK. Indicates document was found and returned.

• Content-Type: application/atomsvc+xml. Indicates payload contains data in Atom Publishing Service Document format.
  

Example

Input HTTP headers:

GET /blogs/api HTTP/1.1
Host: blogs.enterprise.example.com

Response HTTP headers:

HTTP/1.1 200 OK
Content-Type: application/atomsvc+xml

Response content:

<?xml version="1.0"?>
<service xmlns="http://www.w3.org/2007/app">
   <generator version="2.0" 
   uri="http://www.ibm.com/xmlns/prod/sn" 
    xmlns="http://www.w3.org/2005/Atom">IBM Connections - Blogs</generator>
   <workspace>
    <title type="text" xmlns="http://www.w3.org/2005/Atom">Blogs</title>
    <collection href="https://blogs.enterprise.example.com/blogs/homepage/api/blogs">
      <title type="text" xmlns="http://www.w3.org/2005/Atom">My Blogs</title>
      <category 
       term="blogs" 
       scheme="http://www.ibm.com/xmlns/prod/sn/role"
       xmlns="http://www.w3.org/2005/Atom">
         </category>
         <accept>application/atom+xml;type=entry</accept>
         <categories fixed="yes">
         </categories>
      </collection>
   </workspace>
   <workspace>
    <title type="text" xmlns="http://www.w3.org/2005/Atom">Sports Signup </title>
    <collection href="https://blogs.enterprise.example.com/blogs/sporty/api/entries">
      <title type="text" xmlns="http://www.w3.org/2005/Atom">weblog Entries</title>
      <category 
       term="entries" 
       scheme="http://www.ibm.com/xmlns/prod/sn/role"
       xmlns="http://www.w3.org/2005/Atom">
      </category>
      <accept>application/atom+xml;type=entry</accept>
      <categories fixed="no" href="https://blogs.enterprise.example.com/blogs/sporty/api/tags">
      </categories>
    </collection>
    <collection href="https://blogs.enterprise.example.com/blogs/sporty/api/media">
      <title type="text" xmlns="http://www.w3.org/2005/Atom">Media Entries</title>
      <category 
       term="media" 
       scheme="http://www.ibm.com/xmlns/prod/sn/role"
       xmlns="http://www.w3.org/2005/Atom">
      </category>
      <accept>image/jpeg</accept> 
      <accept>image/gif</accept>
      <accept>image/png</accept>
      <categories fixed="yes">
      </categories>
    </collection>
    <collection href="https://blogs.enterprise.example.com/blogs/sporty/api/comments">
      <title type="text" xmlns="http://www.w3.org/2005/Atom">Comments</title>
      <category 
       term="comments" 
       scheme="http://www.ibm.com/xmlns/prod/sn/role"
       xmlns="http://www.w3.org/2005/Atom">
      </category>
      <accept>application/atom+xml;type=entry</accept>
      <categories fixed="yes">
      </categories>
    </collection>
  </workspace>
</service>

Blogs service document content
When working with the Blogs publishing APIs, first obtain the Blogs service document. The service document provides access to all of the Blogs resources that you can update.

Parent topic

Use the publishing APIs

Related reference
Retrieve a blog comment
Delete comments

   

 

});

+

Search Tips   |   Advanced Search