Api Home > Article > RelateToWorkItem

POST api/V3/Article/RelateToWorkItem?workItemId={workItemId} Relates a work item to one or more knowledge articles

Request Information

URI Parameters

NameDescriptionTypeAdditional information
workItemId

The work item's base id

globally unique identifier

Required

Body Parameters

A list of article id's to be related

Collection of integer

Request Formats

application/json, text/json

Sample:
[
  1,
  2
]

application/xml, text/xml

Sample:
<ArrayOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <int>1</int>
  <int>2</int>
</ArrayOfint>

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>