GET api/V3/Article/Get?articleId={articleId} Gets knowledge article details by article id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
articleId |
The article Id |
string |
Required |
Body Parameters
None.Response Information
Returns a knowledge article object
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": "af107d0f-2b45-416e-90bb-4846a0674d44", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "VendorArticleID": "sample string 13", "Popularity": 14, "KAOwner": "c692002c-aba7-478d-8f27-6c3adbef36c8", "Type": "1eee8521-5dd1-4141-bd7f-2e65e0d3ef25", "KAType": { "Id": "af107d0f-2b45-416e-90bb-4846a0674d44", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": "48d1908b-4e6f-4548-9d03-60ea9ff9bae7", "KACategory": { "Id": "af107d0f-2b45-416e-90bb-4846a0674d44", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "CreatedBy": "cbd402cf-39a3-4e8c-98cf-14b6c6cad387", "CreatedDate": "2024-04-18T10:52:25.229Z", "LastModifiedBy": "cbd2d9e1-f2e1-48d9-ba9e-889318465e0b", "LastModifiedDate": "2024-04-18T10:52:25.229Z", "NameRelationship": [ { "Name": "sample string 1", "Class": "eecb1408-2563-4fc5-becd-90aeb0ce8084", "RelationshipId": "cc8aa163-8700-4f1e-9ce9-f23f88c1844a" }, { "Name": "sample string 1", "Class": "eecb1408-2563-4fc5-becd-90aeb0ce8084", "RelationshipId": "cc8aa163-8700-4f1e-9ce9-f23f88c1844a" } ], "RelatesToIncident": { "DisplayName": "sample string 1", "BaseId": "e20d467d-7ed8-411d-b02b-7f94f4feaa2e", "ObjectGuid": "26f287ee-5d50-470d-9a21-e592d6a5400b" }, "Activity": [ {}, {} ], "Status": { "Id": "af107d0f-2b45-416e-90bb-4846a0674d44", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "IsImported": true, "RelatesToServiceOffering": [ { "BaseId": "60776a8f-6175-4f03-beca-31fdb9079054", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "60776a8f-6175-4f03-beca-31fdb9079054", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "RelatesToRequestOffering": [ { "BaseId": "60776a8f-6175-4f03-beca-31fdb9079054", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "60776a8f-6175-4f03-beca-31fdb9079054", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "Rating": 18, "ViewCount": 19, "Comments": [ { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "3b56512d-990e-4ad3-83c6-85dbd39ecf67", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "18334a49-533f-40c9-9de3-8395f46b6802", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-04-18T10:52:25.229Z", "ArchivedDate": "2024-04-18T10:52:25.229Z", "DateUpdated": "2024-04-18T10:52:25.229Z" }, { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "3b56512d-990e-4ad3-83c6-85dbd39ecf67", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "18334a49-533f-40c9-9de3-8395f46b6802", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-04-18T10:52:25.229Z", "ArchivedDate": "2024-04-18T10:52:25.229Z", "DateUpdated": "2024-04-18T10:52:25.229Z" } ], "CategoryBreadcrumbs": [ { "Id": "af107d0f-2b45-416e-90bb-4846a0674d44", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "af107d0f-2b45-416e-90bb-4846a0674d44", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" } ], "ExternalId": "049c1b86-4680-406b-bfdb-4c060f1c1115" }
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>48d1908b-4e6f-4548-9d03-60ea9ff9bae7</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>af107d0f-2b45-416e-90bb-4846a0674d44</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>af107d0f-2b45-416e-90bb-4846a0674d44</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </d2p1:DisplayEnumeration> </CategoryBreadcrumbs> <Comments> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-04-18T10:52:25.2290925+00:00</ArchivedDate> <ArchivedbyUser>18334a49-533f-40c9-9de3-8395f46b6802</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-04-18T10:52:25.2290925+00:00</CreatedDate> <DateUpdated>2024-04-18T10:52:25.2290925+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>3b56512d-990e-4ad3-83c6-85dbd39ecf67</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-04-18T10:52:25.2290925+00:00</ArchivedDate> <ArchivedbyUser>18334a49-533f-40c9-9de3-8395f46b6802</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-04-18T10:52:25.2290925+00:00</CreatedDate> <DateUpdated>2024-04-18T10:52:25.2290925+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>3b56512d-990e-4ad3-83c6-85dbd39ecf67</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> </Comments> <CreatedBy>cbd402cf-39a3-4e8c-98cf-14b6c6cad387</CreatedBy> <CreatedDate>2024-04-18T10:52:25.2290925+00:00</CreatedDate> <EndUserContent>sample string 6</EndUserContent> <EndUserContentType>sample string 7</EndUserContentType> <ExternalId>049c1b86-4680-406b-bfdb-4c060f1c1115</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>af107d0f-2b45-416e-90bb-4846a0674d44</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </KACategory> <KAOwner>c692002c-aba7-478d-8f27-6c3adbef36c8</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>af107d0f-2b45-416e-90bb-4846a0674d44</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>af107d0f-2b45-416e-90bb-4846a0674d44</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </LanguageLocaleID> <LastModifiedBy>cbd2d9e1-f2e1-48d9-ba9e-889318465e0b</LastModifiedBy> <LastModifiedDate>2024-04-18T10:52:25.2290925+00:00</LastModifiedDate> <LocaleID>12</LocaleID> <NameRelationship> <KARelationshipModel> <Class>eecb1408-2563-4fc5-becd-90aeb0ce8084</Class> <Name>sample string 1</Name> <RelationshipId>cc8aa163-8700-4f1e-9ce9-f23f88c1844a</RelationshipId> </KARelationshipModel> <KARelationshipModel> <Class>eecb1408-2563-4fc5-becd-90aeb0ce8084</Class> <Name>sample string 1</Name> <RelationshipId>cc8aa163-8700-4f1e-9ce9-f23f88c1844a</RelationshipId> </KARelationshipModel> </NameRelationship> <Popularity>14</Popularity> <Rating>18</Rating> <RelatesToIncident> <BaseId>e20d467d-7ed8-411d-b02b-7f94f4feaa2e</BaseId> <DisplayName>sample string 1</DisplayName> <ObjectGuid>26f287ee-5d50-470d-9a21-e592d6a5400b</ObjectGuid> </RelatesToIncident> <RelatesToRequestOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>60776a8f-6175-4f03-beca-31fdb9079054</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>60776a8f-6175-4f03-beca-31fdb9079054</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> </RelatesToRequestOffering> <RelatesToServiceOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>60776a8f-6175-4f03-beca-31fdb9079054</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>60776a8f-6175-4f03-beca-31fdb9079054</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>af107d0f-2b45-416e-90bb-4846a0674d44</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </Status> <Title>sample string 3</Title> <Type>1eee8521-5dd1-4141-bd7f-2e65e0d3ef25</Type> <VendorArticleID>sample string 13</VendorArticleID> <ViewCount>19</ViewCount> </HTMLKnowledge>