GET api/teams/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": "6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "VendorArticleID": "sample string 13", "Popularity": 14, "KAOwner": "e85ade9f-7f27-49db-a86c-01715b9f762d", "Type": "4e4ec9fa-69bd-4232-b6b3-b15b2c3a6aa1", "KAType": { "Id": "6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "Category": "9c7ad661-db20-45e3-bcc1-e1055601e474", "KACategory": { "Id": "6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "CreatedBy": "a05cb6d1-33eb-4fc2-9c9a-8f5f19833fe2", "CreatedDate": "2024-04-24T17:39:49.060Z", "LastModifiedBy": "804f3768-6c9b-4e90-87a6-0e0813504147", "LastModifiedDate": "2024-04-24T17:39:49.060Z", "NameRelationship": [ { "Name": "sample string 1", "Class": "8e0cb43f-fa32-4e30-9297-c31e6ba6fd0d", "RelationshipId": "58b55c1d-f133-41c3-bdd5-7d3b83efb60e" }, { "Name": "sample string 1", "Class": "8e0cb43f-fa32-4e30-9297-c31e6ba6fd0d", "RelationshipId": "58b55c1d-f133-41c3-bdd5-7d3b83efb60e" } ], "RelatesToIncident": { "DisplayName": "sample string 1", "BaseId": "1485ca16-759a-4273-9017-698066c1427e", "ObjectGuid": "4dd54ad8-7bd9-4439-a712-87425ab70964" }, "Activity": [ {}, {} ], "Status": { "Id": "6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, "IsImported": true, "RelatesToServiceOffering": [ { "BaseId": "b7cdc77d-3d2c-467f-9d91-c4e75fedfd01", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "b7cdc77d-3d2c-467f-9d91-c4e75fedfd01", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "RelatesToRequestOffering": [ { "BaseId": "b7cdc77d-3d2c-467f-9d91-c4e75fedfd01", "Title": "sample string 1", "BriefDescription": "sample string 2" }, { "BaseId": "b7cdc77d-3d2c-467f-9d91-c4e75fedfd01", "Title": "sample string 1", "BriefDescription": "sample string 2" } ], "Rating": 18, "ViewCount": 19, "Comments": [ { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "29665122-f6dd-4d23-82bc-3f1254feec88", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "85898da7-757f-4cea-9e2a-8a3bf5f35c03", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-04-24T17:39:49.060Z", "ArchivedDate": "2024-04-24T17:39:49.060Z", "DateUpdated": "2024-04-24T17:39:49.060Z" }, { "CommentId": 1, "KnowledgeArticleID": 1, "UserID": "29665122-f6dd-4d23-82bc-3f1254feec88", "UserFirstName": "sample string 2", "UserLastName": "sample string 3", "ArchivedbyUser": "85898da7-757f-4cea-9e2a-8a3bf5f35c03", "Comment": "sample string 5", "Archived": true, "Helpful": true, "CreatedDate": "2024-04-24T17:39:49.060Z", "ArchivedDate": "2024-04-24T17:39:49.060Z", "DateUpdated": "2024-04-24T17:39:49.060Z" } ], "CategoryBreadcrumbs": [ { "Id": "6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" }, { "Id": "6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f", "Name": "sample string 1", "HierarchyLevel": 1, "HierarchyPath": "sample string 2" } ], "ExternalId": "a5ecbd4e-6874-450f-ab2d-193e74d1944f" }
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>9c7ad661-db20-45e3-bcc1-e1055601e474</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>6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f</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>6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </d2p1:DisplayEnumeration> </CategoryBreadcrumbs> <Comments> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-04-24T17:39:49.0604448+00:00</ArchivedDate> <ArchivedbyUser>85898da7-757f-4cea-9e2a-8a3bf5f35c03</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-04-24T17:39:49.0604448+00:00</CreatedDate> <DateUpdated>2024-04-24T17:39:49.0604448+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>29665122-f6dd-4d23-82bc-3f1254feec88</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> <KAComment> <Archived>true</Archived> <ArchivedDate>2024-04-24T17:39:49.0604448+00:00</ArchivedDate> <ArchivedbyUser>85898da7-757f-4cea-9e2a-8a3bf5f35c03</ArchivedbyUser> <Comment>sample string 5</Comment> <CommentId>1</CommentId> <CreatedDate>2024-04-24T17:39:49.0604448+00:00</CreatedDate> <DateUpdated>2024-04-24T17:39:49.0604448+00:00</DateUpdated> <Helpful>true</Helpful> <KnowledgeArticleID>1</KnowledgeArticleID> <UserFirstName>sample string 2</UserFirstName> <UserID>29665122-f6dd-4d23-82bc-3f1254feec88</UserID> <UserLastName>sample string 3</UserLastName> </KAComment> </Comments> <CreatedBy>a05cb6d1-33eb-4fc2-9c9a-8f5f19833fe2</CreatedBy> <CreatedDate>2024-04-24T17:39:49.0604448+00:00</CreatedDate> <EndUserContent>sample string 6</EndUserContent> <EndUserContentType>sample string 7</EndUserContentType> <ExternalId>a5ecbd4e-6874-450f-ab2d-193e74d1944f</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>6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </KACategory> <KAOwner>e85ade9f-7f27-49db-a86c-01715b9f762d</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>6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f</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>6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </LanguageLocaleID> <LastModifiedBy>804f3768-6c9b-4e90-87a6-0e0813504147</LastModifiedBy> <LastModifiedDate>2024-04-24T17:39:49.0604448+00:00</LastModifiedDate> <LocaleID>12</LocaleID> <NameRelationship> <KARelationshipModel> <Class>8e0cb43f-fa32-4e30-9297-c31e6ba6fd0d</Class> <Name>sample string 1</Name> <RelationshipId>58b55c1d-f133-41c3-bdd5-7d3b83efb60e</RelationshipId> </KARelationshipModel> <KARelationshipModel> <Class>8e0cb43f-fa32-4e30-9297-c31e6ba6fd0d</Class> <Name>sample string 1</Name> <RelationshipId>58b55c1d-f133-41c3-bdd5-7d3b83efb60e</RelationshipId> </KARelationshipModel> </NameRelationship> <Popularity>14</Popularity> <Rating>18</Rating> <RelatesToIncident> <BaseId>1485ca16-759a-4273-9017-698066c1427e</BaseId> <DisplayName>sample string 1</DisplayName> <ObjectGuid>4dd54ad8-7bd9-4439-a712-87425ab70964</ObjectGuid> </RelatesToIncident> <RelatesToRequestOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>b7cdc77d-3d2c-467f-9d91-c4e75fedfd01</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>b7cdc77d-3d2c-467f-9d91-c4e75fedfd01</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> </RelatesToRequestOffering> <RelatesToServiceOffering> <HTMLKnowledgeRelatedOfferingObject> <BaseId>b7cdc77d-3d2c-467f-9d91-c4e75fedfd01</BaseId> <BriefDescription>sample string 2</BriefDescription> <Title>sample string 1</Title> </HTMLKnowledgeRelatedOfferingObject> <HTMLKnowledgeRelatedOfferingObject> <BaseId>b7cdc77d-3d2c-467f-9d91-c4e75fedfd01</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>6cc09f0f-eccb-4bf2-9e4a-a6e2da88ab4f</d2p1:Id> <d2p1:Name>sample string 1</d2p1:Name> </Status> <Title>sample string 3</Title> <Type>4e4ec9fa-69bd-4232-b6b3-b15b2c3a6aa1</Type> <VendorArticleID>sample string 13</VendorArticleID> <ViewCount>19</ViewCount> </HTMLKnowledge>