Resources¶

GET /resources¶

See a complete list of resources available on the server.

Example Request:

GET /resources HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<Resources>
  <AdminComponent href="http://doc.sd-demo.sourcefabric.org/resources/Admin/Component/"/>
  <AdminFile href="http://doc.sd-demo.sourcefabric.org/resources/Admin/File/"/>
  <AdminInput href="http://doc.sd-demo.sourcefabric.org/resources/Admin/Input/"/>
  <AdminMessage href="http://doc.sd-demo.sourcefabric.org/resources/Admin/Message/"/>
  <AdminPlugin href="http://doc.sd-demo.sourcefabric.org/resources/Admin/Plugin/"/>
  <AdminRequest href="http://doc.sd-demo.sourcefabric.org/resources/Admin/Request/"/>
  <AdminSource href="http://doc.sd-demo.sourcefabric.org/resources/Admin/Source/"/>
  <ArchiveAudioData href="http://doc.sd-demo.sourcefabric.org/resources/Archive/AudioData/"/>
  <ArchiveAudioInfo href="http://doc.sd-demo.sourcefabric.org/resources/Archive/AudioInfo/"/>
  <ArchiveImageData href="http://doc.sd-demo.sourcefabric.org/resources/Archive/ImageData/"/>
  <ArchiveImageInfo href="http://doc.sd-demo.sourcefabric.org/resources/Archive/ImageInfo/"/>
  <ArchiveMetaData href="http://doc.sd-demo.sourcefabric.org/resources/Archive/MetaData/"/>
  <ArchiveMetaDataInfoQuery href="http://doc.sd-demo.sourcefabric.org/resources/Archive/MetaDataInfo/Query"/>
  <ArchiveMetaInfo href="http://doc.sd-demo.sourcefabric.org/resources/Archive/MetaInfo/"/>
  <ArchiveMetaType href="http://doc.sd-demo.sourcefabric.org/resources/Archive/MetaType/"/>
  <ArchiveQueryCriteria href="http://doc.sd-demo.sourcefabric.org/resources/Archive/QueryCriteria/"/>
  <ArchiveVideoData href="http://doc.sd-demo.sourcefabric.org/resources/Archive/VideoData/"/>
  <ArchiveVideoInfo href="http://doc.sd-demo.sourcefabric.org/resources/Archive/VideoInfo/"/>
  <DataCollaborator href="http://doc.sd-demo.sourcefabric.org/resources/Data/Collaborator/"/>
  <DataPost href="http://doc.sd-demo.sourcefabric.org/resources/Data/Post/"/>
  <DataPostPublished href="http://doc.sd-demo.sourcefabric.org/resources/Data/Post/Published"/>
  <DataPostType href="http://doc.sd-demo.sourcefabric.org/resources/Data/PostType/"/>
  <DataPostUnpublished href="http://doc.sd-demo.sourcefabric.org/resources/Data/Post/Unpublished"/>
  <DataSource href="http://doc.sd-demo.sourcefabric.org/resources/Data/Source/"/>
  <DataSourceType href="http://doc.sd-demo.sourcefabric.org/resources/Data/SourceType/"/>
  <GUIAction href="http://doc.sd-demo.sourcefabric.org/resources/GUI/Action/"/>
  <Gateway href="http://doc.sd-demo.sourcefabric.org/resources/Gateway/"/>
  <GatewayCaptcha href="http://doc.sd-demo.sourcefabric.org/resources/Gateway/Captcha"/>
  <HRPerson href="http://doc.sd-demo.sourcefabric.org/resources/HR/Person/"/>
  <HRUser href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/"/>
  <HRUserType href="http://doc.sd-demo.sourcefabric.org/resources/HR/UserType/"/>
  <LiveDeskBlog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/"/>
  <LiveDeskBlogCollaboratorType href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/BlogCollaboratorType/"/>
  <LiveDeskBlogLive href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/Live"/>
  <LiveDeskBlogMediaType href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/BlogMediaType/"/>
  <LiveDeskBlogTheme href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/BlogTheme/"/>
  <LiveDeskBlogType href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/BlogType/"/>
  <LiveDeskSync href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Sync/"/>
  <LocalizationLanguage href="http://doc.sd-demo.sourcefabric.org/resources/Localization/Language/"/>
  <LocalizationLanguageAvailable href="http://doc.sd-demo.sourcefabric.org/resources/Localization/Language/Available"/>
  <RBACRole href="http://doc.sd-demo.sourcefabric.org/resources/RBAC/Role/"/>
  <SecurityRight href="http://doc.sd-demo.sourcefabric.org/resources/Security/Right/"/>
  <SecurityRightType href="http://doc.sd-demo.sourcefabric.org/resources/Security/RightType/"/>
  <ToolURLInfo href="http://doc.sd-demo.sourcefabric.org/resources/Tool/URLInfo/"/>
</Resources>

Blogs¶

Resources related to Blogs.

GET /resources/LiveDesk/Blog¶

Lists available blogs.

Example Request:

GET /resources/LiveDesk/Blog HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<BlogList total="5" limit="5" offset="0">
    <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/1"/>
    <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/2"/>
    <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/3"/>
    <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4"/>
    <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/5"/>
</BlogList>

Get a complete list of parameters by adding &params=show to your request.

GET /resources/HR/User/(int: id)/Blog¶

Lists blogs assigned to user id.

Example Request:

GET /resources/HR/User/5/Blog HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<BlogList total="1" limit="1" offset="0">
  <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/2"/>
</BlogList>

Get a complete list of parameters by adding &params=show to your request.

GET /resources/HR/User/(int: id)/Blog/Live¶

Lists live blogs assigned to user id.

Example Request:

GET /resources/HR/User/5/Blog/Live HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<BlogList>
  <Blog href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/2"/>
</BlogList>

Get a complete list of parameters by adding &params=show to your request.

GET /resources/LiveDesk/Blog/(int: id)¶

Shows information about Blog id.

Example Request:

GET /resources/LiveDesk/Blog/4 HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<Blog>
  <Id>4</Id>
  <IsLive>False</IsLive>
  <Description>&lt;span class="placeholder"&gt;and some description&lt;span style="display: none;" sel-id="sel-1373981816301-18497082770598405"&gt;﻿&lt;/span&gt;&lt;/span&gt;</Description>
  <Title>Test live blog to reproduce duplication of republished wrap-up posts</Title>
  <CreatedOn>7/15/13 4:58 PM</CreatedOn>
  <UpdatedOn>6/18/13 2:53 PM</UpdatedOn>
  <Creator href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/2">
    <Id>2</Id>
  </Creator>
  <Language href="http://doc.sd-demo.sourcefabric.org/resources/Localization/Language/3">
    <Id>3</Id>
  </Language>
  <Type href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/BlogType/2">
    <Id>2</Id>
  </Type>
  <Collaborator href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Collaborator/"/>
  <CollaboratorPotential href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Collaborator/Potential"/>
  <Sync href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Sync/"/>
  <Configuration href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Configuration/"/>
  <Post href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Post/"/>
  <PostComment href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Post/Comment"/>
  <PostPublished href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Post/Published"/>
  <PostUnpublished href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Post/Unpublished"/>
  <CommentPost href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Comment/Post/"/>
  <Source href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Source/"/>
  <BlogMedia href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/BlogMedia/"/>
</Blog>

Get a complete list of parameters by adding &params=show to your request.

Posts¶

GET /resources/LiveDesk/Blog/(int: id)/Post/Published¶

Shows all published posts on Blog id.

Example Request:

GET /resources/LiveDesk/Blog/4/Post/Published HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<PostList offsetMore="2" total="2" limit="2" lastCId="191" offset="0">
  <Post href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Post/73"/>
  <Post href="http://doc.sd-demo.sourcefabric.org/resources/LiveDesk/Blog/4/Post/72"/>
</PostList>

Get a complete list of parameters by adding &params=show to your request.

POST /resources/LiveDesk/Blog/(int: id)/Post¶

Insert a post into Blog id, but do not publish it.

Example Request:

POST /resources/LiveDesk/Blog/4/Post/ HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Request Headers:
	Authorization – Session authorization token, see Authentication

POST /resources/LiveDesk/Blog/(int: id)/Post/Publish¶

Insert a post into Blog id and publish it immediately.

Example Request:

POST /resources/LiveDesk/Blog/4/Post/ HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Request Headers:
	Authorization – Session authorization token, see Authentication

Users¶

GET /resources/HR/User/(int: id)¶

Show information about user id.

Example Request:

GET /resources/HR/User/5 HTTP/1.1
Host: http://doc.sd-demo.sourcefabric.org

Example Response:

<?xml version="1.0" encoding="UTF-8"?>
<User>
  <Id>5</Id>
  <Active>True</Active>
  <EMail>Sarah.Stringer@email.addr</EMail>
  <FirstName>Sarah</FirstName>
  <FullName>Sarah Stringer</FullName>
  <LastName>Stringer</LastName>
  <Name>stringer</Name>
  <CreatedOn>7/2/13 11:43 AM</CreatedOn>
  <Type href="http://doc.sd-demo.sourcefabric.org/resources/HR/UserType/standard">
    <Key>standard</Key>
  </Type>
  <Role href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Role/"/>
  <Right href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Right/"/>
  <Blog href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Blog/"/>
  <BlogLive href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Blog/Live"/>
  <Action href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Action/"/>
  <Post href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Post/"/>
  <PostPublished href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Post/Published"/>
  <PostUnpublished href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Post/Unpublished"/>
  <Collaborator href="http://doc.sd-demo.sourcefabric.org/resources/HR/User/5/Collaborator/"/>
  <MetaDataIcon href="http://doc.sd-demo.sourcefabric.org/resources/HR/Person/5/MetaData/Icon"/>
</User>

Get a complete list of parameters by adding &params=show to your request.