GET v1/Article/{articleKey}/Description/Suggest

Based on an article's Genre and the Custom Field Values currently assigned to the article, provide a list of suggested document descriptions. If a user wants to assign a document description to an article, there is a separate API endpoint for creating a document description.

Roles Allowed

admin, editor

Request Information

URI Parameters

Name	Description	Type	Additional information
articleKey		integer	Required

Body Parameters

None.

Response Information

Resource Description

A list of suggested descriptions with the associated Document Type

Collection of DocumentTypeWithDescriptions

Name	Type	Additional information
DocumentDescriptions	Collection of string	None.
DocumentTypeId	integer	None.
DocumentTypeName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentDescriptions": [
      "sample string 1",
      "sample string 2"
    ],
    "DocumentTypeId": 1,
    "DocumentTypeName": "sample string 2"
  },
  {
    "DocumentDescriptions": [
      "sample string 1",
      "sample string 2"
    ],
    "DocumentTypeId": 1,
    "DocumentTypeName": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocumentTypeWithDescriptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <DocumentTypeWithDescriptions>
    <DocumentTypeId>1</DocumentTypeId>
    <DocumentTypeName>sample string 2</DocumentTypeName>
    <DocumentDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </DocumentDescriptions>
  </DocumentTypeWithDescriptions>
  <DocumentTypeWithDescriptions>
    <DocumentTypeId>1</DocumentTypeId>
    <DocumentTypeName>sample string 2</DocumentTypeName>
    <DocumentDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </DocumentDescriptions>
  </DocumentTypeWithDescriptions>
</ArrayOfDocumentTypeWithDescriptions>