PATCH api/V3/Article/Patch

Api Home > Article > Patch

PATCH api/V3/Article/Patch Updates a batch of article's popularity index only.

Request Information

URI Parameters

None.

Body Parameters

Collection of KnowledgeArticle

Name	Type	Additional information
Id	globally unique identifier	None.
ArticleId	string	None.
Title	string	None.
Popularity	integer	None.
Description	string	None.
ExternalUrl	string	None.
EndUserContent	string	None.
AnalystContent	string	None.
HasEndUserContent	boolean	None.
HasAnalystContent	boolean	None.
HTMLKnowledgeId	string	None.
Type	DisplayEnumeration	None.
Category	DisplayEnumeration	None.
Status	DisplayEnumeration	None.
StatusString	string	None.
ViewCount	integer	None.
CommentCount	integer	None.
AverageRating	decimal number	None.
LastModifiedDate	date	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "Id": "8c6a7207-910a-49c8-8717-2a183adc4c33",
    "ArticleId": "sample string 2",
    "Title": "sample string 3",
    "Popularity": 4,
    "Description": "sample string 5",
    "ExternalUrl": "sample string 6",
    "EndUserContent": "sample string 7",
    "AnalystContent": "sample string 8",
    "HasEndUserContent": true,
    "HasAnalystContent": true,
    "HTMLKnowledgeId": "sample string 11",
    "Type": {
      "Id": "f89229e4-e849-4869-bfe6-ee864d1f3f2a",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Category": {
      "Id": "f89229e4-e849-4869-bfe6-ee864d1f3f2a",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Status": {
      "Id": "f89229e4-e849-4869-bfe6-ee864d1f3f2a",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "StatusString": "sample string 12",
    "ViewCount": 13,
    "CommentCount": 14,
    "AverageRating": 15.0,
    "LastModifiedDate": "2024-04-26T01:01:18.181Z"
  },
  {
    "Id": "8c6a7207-910a-49c8-8717-2a183adc4c33",
    "ArticleId": "sample string 2",
    "Title": "sample string 3",
    "Popularity": 4,
    "Description": "sample string 5",
    "ExternalUrl": "sample string 6",
    "EndUserContent": "sample string 7",
    "AnalystContent": "sample string 8",
    "HasEndUserContent": true,
    "HasAnalystContent": true,
    "HTMLKnowledgeId": "sample string 11",
    "Type": {
      "Id": "f89229e4-e849-4869-bfe6-ee864d1f3f2a",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Category": {
      "Id": "f89229e4-e849-4869-bfe6-ee864d1f3f2a",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "Status": {
      "Id": "f89229e4-e849-4869-bfe6-ee864d1f3f2a",
      "Name": "sample string 1",
      "HierarchyLevel": 1,
      "HierarchyPath": "sample string 2"
    },
    "StatusString": "sample string 12",
    "ViewCount": 13,
    "CommentCount": 14,
    "AverageRating": 15.0,
    "LastModifiedDate": "2024-04-26T01:01:18.181Z"
  }
]

application/xml, text/xml

Sample:

<ArrayOfKnowledgeArticle xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.WebConsole.ViewModels">
  <KnowledgeArticle>
    <AnalystContent>sample string 8</AnalystContent>
    <ArticleId>sample string 2</ArticleId>
    <AverageRating>15</AverageRating>
    <Category xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>f89229e4-e849-4869-bfe6-ee864d1f3f2a</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Category>
    <CommentCount>14</CommentCount>
    <Description>sample string 5</Description>
    <EndUserContent>sample string 7</EndUserContent>
    <ExternalUrl>sample string 6</ExternalUrl>
    <HTMLKnowledgeId>sample string 11</HTMLKnowledgeId>
    <HasAnalystContent>true</HasAnalystContent>
    <HasEndUserContent>true</HasEndUserContent>
    <Id>8c6a7207-910a-49c8-8717-2a183adc4c33</Id>
    <LastModifiedDate>2024-04-26T01:01:18.1816411+00:00</LastModifiedDate>
    <Popularity>4</Popularity>
    <Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>f89229e4-e849-4869-bfe6-ee864d1f3f2a</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Status>
    <StatusString>sample string 12</StatusString>
    <Title>sample string 3</Title>
    <Type xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>f89229e4-e849-4869-bfe6-ee864d1f3f2a</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Type>
    <ViewCount>13</ViewCount>
  </KnowledgeArticle>
  <KnowledgeArticle>
    <AnalystContent>sample string 8</AnalystContent>
    <ArticleId>sample string 2</ArticleId>
    <AverageRating>15</AverageRating>
    <Category xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>f89229e4-e849-4869-bfe6-ee864d1f3f2a</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Category>
    <CommentCount>14</CommentCount>
    <Description>sample string 5</Description>
    <EndUserContent>sample string 7</EndUserContent>
    <ExternalUrl>sample string 6</ExternalUrl>
    <HTMLKnowledgeId>sample string 11</HTMLKnowledgeId>
    <HasAnalystContent>true</HasAnalystContent>
    <HasEndUserContent>true</HasEndUserContent>
    <Id>8c6a7207-910a-49c8-8717-2a183adc4c33</Id>
    <LastModifiedDate>2024-04-26T01:01:18.1816411+00:00</LastModifiedDate>
    <Popularity>4</Popularity>
    <Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>f89229e4-e849-4869-bfe6-ee864d1f3f2a</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Status>
    <StatusString>sample string 12</StatusString>
    <Title>sample string 3</Title>
    <Type xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Domain">
      <d3p1:HierarchyLevel>1</d3p1:HierarchyLevel>
      <d3p1:HierarchyPath>sample string 2</d3p1:HierarchyPath>
      <d3p1:Id>f89229e4-e849-4869-bfe6-ee864d1f3f2a</d3p1:Id>
      <d3p1:Name>sample string 1</d3p1:Name>
    </Type>
    <ViewCount>13</ViewCount>
  </KnowledgeArticle>
</ArrayOfKnowledgeArticle>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Returns true if number of records updated is greater than zero

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>