GET api/V3/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": "24725bd7-31aa-46a8-8033-f58aa08bbaa0", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "VendorArticleID": "sample string 13", "Popularity": 14, "KAOwner": "0d92f66c-e9c9-4d6b-9765-7f64cbd4cb35", "Type": "a422fa7b-8547-4f93-b70b-dc7af91d6c31", "KAType": { "Id": "24725bd7-31aa-46a8-8033-f58aa08bbaa0", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": "c8b3613e-baf2-4b09-81b4-f319933dca03", "KACategory": { "Id": "24725bd7-31aa-46a8-8033-f58aa08bbaa0", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "CreatedBy": "380c91e4-c315-47e1-807b-c8414963cf69", "CreatedDate": "2024-03-29T07:15:36.321Z", "LastModifiedBy": "23cd6438-f95c-4f3c-a8ef-5bab7d4d2fce", "LastModifiedDate": "2024-03-29T07:15:36.321Z", "NameRelationship": [ { "Name": "sample string 1", "Class": "5e33e71d-c614-4c87-a549-d0e3414c6a54", "RelationshipId": "de59ac00-75d1-4f15-8730-d7f57d5505d6" }, { "Name": "sample string 1", "Class": "5e33e71d-c614-4c87-a549-d0e3414c6a54", "RelationshipId": "de59ac00-75d1-4f15-8730-d7f57d5505d6" } ], "RelatesToIncident": { "DisplayName": "sample string 1", "BaseId": "3fb2f3a0-981b-48c6-b81c-bc3d657ac5ab", "ObjectGuid": "ca223bb6-bf16-48a1-a7e2-ab0e6f29ac7b" }, "Activity": [ {}, {} ], "Status": { "Id": "24725bd7-31aa-46a8-8033-f58aa08bbaa0", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "IsImported": true, "RelatesToServiceOffering": [ { "BaseId": "d548faf6-8580-46fd-b728-f21bad4d4d04", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "d548faf6-8580-46fd-b728-f21bad4d4d04", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "RelatesToRequestOffering": [ { "BaseId": "d548faf6-8580-46fd-b728-f21bad4d4d04", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "d548faf6-8580-46fd-b728-f21bad4d4d04", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "Rating": 18, "ViewCount": 19, "Comments": [ { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "cd382b20-7aaa-4c4a-9500-afe89ca7acf7", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "37ddbce5-5377-47d1-8fe5-4b2c8d1372e0", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-03-29T07:15:36.321Z", "ArchivedDate": "2024-03-29T07:15:36.321Z", "DateUpdated": "2024-03-29T07:15:36.321Z" }, { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "cd382b20-7aaa-4c4a-9500-afe89ca7acf7", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "37ddbce5-5377-47d1-8fe5-4b2c8d1372e0", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-03-29T07:15:36.321Z", "ArchivedDate": "2024-03-29T07:15:36.321Z", "DateUpdated": "2024-03-29T07:15:36.321Z" } ], "CategoryBreadcrumbs": [ { "Id": "24725bd7-31aa-46a8-8033-f58aa08bbaa0", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "24725bd7-31aa-46a8-8033-f58aa08bbaa0", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" } ], "ExternalId": "f88fc9d5-af5a-4d62-b81d-8622ec600b1b" }
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>c8b3613e-baf2-4b09-81b4-f319933dca03</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>24725bd7-31aa-46a8-8033-f58aa08bbaa0</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>24725bd7-31aa-46a8-8033-f58aa08bbaa0</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </d2p1:DisplayEnumeration> </CategoryBreadcrumbs> <Comments> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-03-29T07:15:36.3211619+00:00</ArchivedDate> <ArchivedbyUser>37ddbce5-5377-47d1-8fe5-4b2c8d1372e0</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-03-29T07:15:36.3211619+00:00</CreatedDate> <DateUpdated>2024-03-29T07:15:36.3211619+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>cd382b20-7aaa-4c4a-9500-afe89ca7acf7</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-03-29T07:15:36.3211619+00:00</ArchivedDate> <ArchivedbyUser>37ddbce5-5377-47d1-8fe5-4b2c8d1372e0</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-03-29T07:15:36.3211619+00:00</CreatedDate> <DateUpdated>2024-03-29T07:15:36.3211619+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>cd382b20-7aaa-4c4a-9500-afe89ca7acf7</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> </Comments> <CreatedBy>380c91e4-c315-47e1-807b-c8414963cf69</CreatedBy> <CreatedDate>2024-03-29T07:15:36.3211619+00:00</CreatedDate> <EndUserContent>sample string 6</EndUserContent> <EndUserContentType>sample string 7</EndUserContentType> <ExternalId>f88fc9d5-af5a-4d62-b81d-8622ec600b1b</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>24725bd7-31aa-46a8-8033-f58aa08bbaa0</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </KACategory> <KAOwner>0d92f66c-e9c9-4d6b-9765-7f64cbd4cb35</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>24725bd7-31aa-46a8-8033-f58aa08bbaa0</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>24725bd7-31aa-46a8-8033-f58aa08bbaa0</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </LanguageLocaleID> <LastModifiedBy>23cd6438-f95c-4f3c-a8ef-5bab7d4d2fce</LastModifiedBy> <LastModifiedDate>2024-03-29T07:15:36.3211619+00:00</LastModifiedDate> <LocaleID>12</LocaleID> <NameRelationship> <KARelationshipModel> <Class>5e33e71d-c614-4c87-a549-d0e3414c6a54</Class> <Name>sample string 1</Name> <RelationshipId>de59ac00-75d1-4f15-8730-d7f57d5505d6</RelationshipId> </KARelationshipModel> <KARelationshipModel> <Class>5e33e71d-c614-4c87-a549-d0e3414c6a54</Class> <Name>sample string 1</Name> <RelationshipId>de59ac00-75d1-4f15-8730-d7f57d5505d6</RelationshipId> </KARelationshipModel> </NameRelationship> <Popularity>14</Popularity> <Rating>18</Rating> <RelatesToIncident> <BaseId>3fb2f3a0-981b-48c6-b81c-bc3d657ac5ab</BaseId> <DisplayName>sample string 1</DisplayName> <ObjectGuid>ca223bb6-bf16-48a1-a7e2-ab0e6f29ac7b</ObjectGuid> </RelatesToIncident> <RelatesToRequestOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>d548faf6-8580-46fd-b728-f21bad4d4d04</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>d548faf6-8580-46fd-b728-f21bad4d4d04</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> </RelatesToRequestOffering> <RelatesToServiceOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>d548faf6-8580-46fd-b728-f21bad4d4d04</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>d548faf6-8580-46fd-b728-f21bad4d4d04</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>24725bd7-31aa-46a8-8033-f58aa08bbaa0</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </Status> <Title>sample string 3</Title> <Type>a422fa7b-8547-4f93-b70b-dc7af91d6c31</Type> <VendorArticleID>sample string 13</VendorArticleID> <ViewCount>19</ViewCount> </HTMLKnowledge>