/document

These api requests will help a user to get more information about a specific document. They will all require a document id, prefixed by the document type, such as 5 for article. Currently most of these api requests will only be useful in the situtation of user submitted documents.

Table of Contents #

GET /document/comments #

Gets the comments for a specific document.

Users can add comments to documents which are visible to other users in the same Group as the commenter. This endpoint allows the caller to retrieve the comments provided the caller have the appropriate rights.

Request

/document/comments{parameters}

Parameters

docId (itemRef) : Document that the comments are based on.

Response

Example: This api request document/comments?docid=5_2266594143780208641&type=json will produce:

{
   Items: [
      {
         PublicationDate: "2013-02-08T11:22:50Z",
         CreatedDate: "2013-02-08T11:22:10Z",
         Publisher: "halif",
         Language: "en",
         IndexOrder: 100187333,
         ContributingUserId: 12595,
         ContributingUsername: " ",
         SilobreakerUrl: "https://my.silobreaker.com/5_2266595622524026880",
         Id: "5_2266595622524026880",
         Description: "Beat By Dre isn't that good",
         Type: "Article Comment",
         LocalizedType: "Article Comment",
         Extras: {
            DocumentFullText: {
               HtmlFullText: "Interesting article but I find the product really bad.",
               ContainsHighlightedTokens: false,
               LastUpdated: "0001-01-01T00:00:00"
            }
         },
      LastUpdated: "0001-01-01T00:00:00"
      },
      {
         PublicationDate: "2013-02-21T14:50:45Z",
         CreatedDate: "2013-02-21T14:50:30Z",
         Publisher: "halif",
         Language: "en",
         IndexOrder: 101677292,
         ContributingUserId: 12595,
         ContributingUsername: " ",
         SilobreakerUrl: "https://my.silobreaker.com/5_2266624445965664256",
         Id: "5_2266624445965664256",
         Description: "I need new headphones",
         Type: "Article Comment",
         LocalizedType: "Article Comment",
         Extras: {
            DocumentFullText: {
               HtmlFullText: "Do you recommend these headphones, my gf has them but I'm not convinced myself if I should get them or not.",
               ContainsHighlightedTokens: false,
               LastUpdated: "0001-01-01T00:00:00"
            }
         },
         LastUpdated: "0001-01-01T00:00:00"
      }
   ],
   LastUpdated: "0001-01-01T00:00:00"
}

GET /document/attachments #

Gets attachments for a document.

Using My Content, users can compose their own documnets, and add attachments to them. This endpoint retrieves the attachments for a given document, and each attachment is returned as a secure link to download the file.

Request

/document/attachments{parameters}

Parameters

docId (itemRef) : Document to retrieve attachments for.

Response

This api request document/attachments?docid=5_2266602298983579649&type=json will produce:

{
   Items: [
      {
         PublicationDate: "2013-02-11T12:32:46Z",
         CreatedDate: "2013-02-11T12:32:04Z",
         Publisher: "LoL",
         Language: "en",
         SourceUrl: "https://api.silobreaker.com/SecureFiles/GetFile.aspx?sf=Zj1zZWN1cmUlMmZmJTJmbSUyZmIlMmZmbWJxYmRyZ3lvemMtTG9MXy1fTmV3X1VzZXJfR3VpZGUucGRmJnU9MCZnPTE4JjZOblR0K2hEdlZDRXZKQTZrdy9mcG10VHBsYz0=",
         IndexOrder: 100557100,
         ContributingUserId: 12595,
         ContributingUsername: "halif",
         SilobreakerUrl: "https://api.silobreaker.com/5_2266602298983579648",
         Id: "5_2266602298983579648",
         Description: "LoL - New User Guide",
         Type: "Manual Article",
         LocalizedType: "Manual Article",
         LastUpdated: "0001-01-01T00:00:00"
      },
      {
         Link: "https://api.silobreaker.com/SecureFiles/GetFile.aspx?sf=Zj1zZWN1cmUlMmZmJTJmbSUyZmIlMmZmbWJxYmRyZ3lvemMtTG9MXy1fTmV3X1VzZXJfR3VpZGUudHh0JnU9MCZnPTE4JmNMRUh6Q05IS29sNlhMOGd2NjFsNzFxYVZ2cz0=",
         Description: "_New_User_Guide.txt",
         LastUpdated: "0001-01-01T00:00:00"
      }
   ],
   LastUpdated: "0001-01-01T00:00:00"
}

GET /document/keywords #

Gets the keywords assigned to a document.

When submitting documents to the system, a user can specify keywords that describe the document. This api request will retrive the keywords for a specific document.

Request

/document/keywords{parameters}

Parameters

docId (itemRef): Document to retrive keywords for.

Response

Example: The api request document/keywords?docid=5_2266602298983579649&type=json will produce:

{
   Items: [
      {
         Description: "Halif",
         Type: "Keyword",
         LastUpdated: "0001-01-01T00:00:00"
      },
      {
         Description: "Panda Annie",
         Type: "Keyword",
         LastUpdated: "0001-01-01T00:00:00"
      },
      {
         Description: "Dragonwing Corki",
         Type: "Keyword",
         LastUpdated: "0001-01-01T00:00:00"
      },
      {
         Description: "Jade Fange Cassiopeia",
         Type: "Keyword",
         LastUpdated: "0001-01-01T00:00:00"
      },
      {
         Description: "Warring Kingdoms Xin Zhao",
         Type: "Keyword",
         LastUpdated: "0001-01-01T00:00:00"
      },
      {
         Description: "Warring Kingdoms Jarvan IV",
         Type: "Keyword",
         LastUpdated: "0001-01-01T00:00:00"
      }
   ],
   LastUpdated: "0001-01-01T00:00:00"
}

GET /document/categories #

Gets the categories assigned to a a document.

Request

GET /document/categories{parameters}

Parameters

docId (itemRef): Document to retrive categories for.

Response

Example: The api request https://api.silobreaker.com/document/categories?docid=5_2266602298983579649&type=json will produce:

{
   Items: [
      {
         Description: "Gaming",
         Type: "Category",
         LastUpdated: "0001-01-01T00:00:00"
      }
   ],
   LastUpdated: "0001-01-01T00:00:00"
}

Documentation generated by mdoc.