GET api/teams/KnowledgeBase/GetHTMLKnowledgeArticle?knowledgeArticleId={knowledgeArticleId} (Deprecated) Returns the specified html knowledge article.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
knowledgeArticleId |
The article Id |
string |
Default value is |
Body Parameters
None.Response Information
Resource Description
HTMLKnowledgeName | Description | Type | Additional information |
---|---|---|---|
IsNew | boolean |
None. |
|
ArticleId | integer |
None. |
|
Title | string |
None. |
|
Abstract | string |
None. |
|
Keywords | string |
None. |
|
EndUserContent | string |
None. |
|
EndUserContentType | string |
None. |
|
AnalystContent | string |
None. |
|
AnalystContentType | string |
None. |
|
ExternalURLSource | string |
None. |
|
ExternalURL | string |
None. |
|
LocaleID | integer |
None. |
|
LanguageLocaleID | DisplayEnumeration |
None. |
|
VendorArticleID | string |
None. |
|
Popularity | integer |
None. |
|
KAOwner | globally unique identifier |
None. |
|
Type | globally unique identifier |
None. |
|
KAType | DisplayEnumeration |
None. |
|
Category | globally unique identifier |
None. |
|
KACategory | DisplayEnumeration |
None. |
|
CreatedBy | globally unique identifier |
None. |
|
CreatedDate | date |
None. |
|
LastModifiedBy | globally unique identifier |
None. |
|
LastModifiedDate | date |
None. |
|
NameRelationship | Collection of KARelationshipModel |
None. |
|
RelatesToIncident | OwnerToAdd |
None. |
|
Activity | Collection of Object |
None. |
|
Status | DisplayEnumeration |
None. |
|
IsImported | boolean |
None. |
|
RelatesToServiceOffering | Collection of HTMLKnowledgeRelatedOfferingObject |
None. |
|
RelatesToRequestOffering | Collection of HTMLKnowledgeRelatedOfferingObject |
None. |
|
Rating | integer |
None. |
|
ViewCount | integer |
None. |
|
Comments | Collection of KAComment |
None. |
|
CategoryBreadcrumbs | Collection of DisplayEnumeration |
None. |
|
ExternalId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsNew": true, "ArticleId": 2, "Title": "sample string 3", "Abstract": "sample string 4", "Keywords": "sample string 5", "EndUserContent": "sample string 6", "EndUserContentType": "sample string 7", "AnalystContent": "sample string 8", "AnalystContentType": "sample string 9", "ExternalURLSource": "sample string 10", "ExternalURL": "sample string 11", "LocaleID": 12, "LanguageLocaleID": { "Id": "e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "VendorArticleID": "sample string 13", "Popularity": 14, "KAOwner": "7ba787f4-4690-4a69-93f5-3b2e65efe6b1", "Type": "b982ff76-a807-4fed-9732-5c10dadb9d28", "KAType": { "Id": "e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": "f87a462b-c391-4a14-b44e-ed5fbc3d34cb", "KACategory": { "Id": "e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "CreatedBy": "414cf732-311b-45f8-ba67-ce0e58d09faa", "CreatedDate": "2024-04-20T01:19:35.285Z", "LastModifiedBy": "b8116a2e-bec5-42a7-b709-0e5d9a7799f1", "LastModifiedDate": "2024-04-20T01:19:35.285Z", "NameRelationship": [ { "Name": "sample string 1", "Class": "85fec9f6-b4b1-4ad4-a34e-f23b5aa0bc28", "RelationshipId": "5035578d-13b6-486e-b90f-c3e8843cd2a1" }, { "Name": "sample string 1", "Class": "85fec9f6-b4b1-4ad4-a34e-f23b5aa0bc28", "RelationshipId": "5035578d-13b6-486e-b90f-c3e8843cd2a1" } ], "RelatesToIncident": { "DisplayName": "sample string 1", "BaseId": "82b8d7f9-e52a-41f0-a3b0-05db5ee0018e", "ObjectGuid": "d0d73fca-7992-48f8-aff3-8d82f4925631" }, "Activity": [ {}, {} ], "Status": { "Id": "e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "IsImported": true, "RelatesToServiceOffering": [ { "BaseId": "7cc29b3c-11e0-4cf9-94ce-e75aa69217b3", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "7cc29b3c-11e0-4cf9-94ce-e75aa69217b3", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "RelatesToRequestOffering": [ { "BaseId": "7cc29b3c-11e0-4cf9-94ce-e75aa69217b3", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "7cc29b3c-11e0-4cf9-94ce-e75aa69217b3", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "Rating": 18, "ViewCount": 19, "Comments": [ { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "8c276780-5b99-4c7b-abb4-180d25a9e699", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "0141d9b3-ff00-416b-b4c5-a4ed569a452a", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-04-20T01:19:35.285Z", "ArchivedDate": "2024-04-20T01:19:35.285Z", "DateUpdated": "2024-04-20T01:19:35.285Z" }, { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "8c276780-5b99-4c7b-abb4-180d25a9e699", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "0141d9b3-ff00-416b-b4c5-a4ed569a452a", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-04-20T01:19:35.285Z", "ArchivedDate": "2024-04-20T01:19:35.285Z", "DateUpdated": "2024-04-20T01:19:35.285Z" } ], "CategoryBreadcrumbs": [ { "Id": "e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" } ], "ExternalId": "5487db15-6d92-49df-b588-1c63fd892fb3" }
application/xml, text/xml
Sample:
<HTMLKnowledge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels"> <Abstract>sample string 4</Abstract> <Activity xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:anyType /> <d2p1:anyType /> </Activity> <AnalystContent>sample string 8</AnalystContent> <AnalystContentType>sample string 9</AnalystContentType> <ArticleId>2</ArticleId> <Category>f87a462b-c391-4a14-b44e-ed5fbc3d34cb</Category> <CategoryBreadcrumbs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain"> <d2p1:DisplayEnumeration> <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel> <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath> <d2p1:Id>e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </d2p1:DisplayEnumeration> <d2p1:DisplayEnumeration> <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel> <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath> <d2p1:Id>e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </d2p1:DisplayEnumeration> </CategoryBreadcrumbs> <Comments> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-04-20T01:19:35.2853956+00:00</ArchivedDate> <ArchivedbyUser>0141d9b3-ff00-416b-b4c5-a4ed569a452a</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-04-20T01:19:35.2853956+00:00</CreatedDate> <DateUpdated>2024-04-20T01:19:35.2853956+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>8c276780-5b99-4c7b-abb4-180d25a9e699</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-04-20T01:19:35.2853956+00:00</ArchivedDate> <ArchivedbyUser>0141d9b3-ff00-416b-b4c5-a4ed569a452a</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-04-20T01:19:35.2853956+00:00</CreatedDate> <DateUpdated>2024-04-20T01:19:35.2853956+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>8c276780-5b99-4c7b-abb4-180d25a9e699</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> </Comments> <CreatedBy>414cf732-311b-45f8-ba67-ce0e58d09faa</CreatedBy> <CreatedDate>2024-04-20T01:19:35.2853956+00:00</CreatedDate> <EndUserContent>sample string 6</EndUserContent> <EndUserContentType>sample string 7</EndUserContentType> <ExternalId>5487db15-6d92-49df-b588-1c63fd892fb3</ExternalId> <ExternalURL>sample string 11</ExternalURL> <ExternalURLSource>sample string 10</ExternalURLSource> <IsImported>true</IsImported> <IsNew>true</IsNew> <KACategory xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain"> <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel> <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath> <d2p1:Id>e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </KACategory> <KAOwner>7ba787f4-4690-4a69-93f5-3b2e65efe6b1</KAOwner> <KAType xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain"> <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel> <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath> <d2p1:Id>e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </KAType> <Keywords>sample string 5</Keywords> <LanguageLocaleID xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain"> <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel> <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath> <d2p1:Id>e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </LanguageLocaleID> <LastModifiedBy>b8116a2e-bec5-42a7-b709-0e5d9a7799f1</LastModifiedBy> <LastModifiedDate>2024-04-20T01:19:35.2853956+00:00</LastModifiedDate> <LocaleID>12</LocaleID> <NameRelationship> <KARelationshipModel> <Class>85fec9f6-b4b1-4ad4-a34e-f23b5aa0bc28</Class> <Name>sample string 1</Name> <RelationshipId>5035578d-13b6-486e-b90f-c3e8843cd2a1</RelationshipId> </KARelationshipModel> <KARelationshipModel> <Class>85fec9f6-b4b1-4ad4-a34e-f23b5aa0bc28</Class> <Name>sample string 1</Name> <RelationshipId>5035578d-13b6-486e-b90f-c3e8843cd2a1</RelationshipId> </KARelationshipModel> </NameRelationship> <Popularity>14</Popularity> <Rating>18</Rating> <RelatesToIncident> <BaseId>82b8d7f9-e52a-41f0-a3b0-05db5ee0018e</BaseId> <DisplayName>sample string 1</DisplayName> <ObjectGuid>d0d73fca-7992-48f8-aff3-8d82f4925631</ObjectGuid> </RelatesToIncident> <RelatesToRequestOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>7cc29b3c-11e0-4cf9-94ce-e75aa69217b3</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>7cc29b3c-11e0-4cf9-94ce-e75aa69217b3</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> </RelatesToRequestOffering> <RelatesToServiceOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>7cc29b3c-11e0-4cf9-94ce-e75aa69217b3</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>7cc29b3c-11e0-4cf9-94ce-e75aa69217b3</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> </RelatesToServiceOffering> <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain"> <d2p1:HierarchyLevel>1</d2p1:HierarchyLevel> <d2p1:HierarchyPath>sample string 2</d2p1:HierarchyPath> <d2p1:Id>e6fd49e8-243e-4ae9-92ca-52f0f92e5cf6</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </Status> <Title>sample string 3</Title> <Type>b982ff76-a807-4fed-9732-5c10dadb9d28</Type> <VendorArticleID>sample string 13</VendorArticleID> <ViewCount>19</ViewCount> </HTMLKnowledge>