Follow

Get Article

Table of Contents
  1. 1. Overview
  2. 2. Arguments
      1. 2.1.1. Example
    1. 2.2. Results
      1. 2.2.1. SUCCESS
      2. 2.2.2. FAILURE
  3. 3. Related

Overview

The Get Article commands allow you to return the content of an article specified by ID or name.  This command returns the article id, name, title, description, deck, callout, body, author name, author email, and author bio of the specified article.  

Arguments

The Get Article commands require the following arguments: Command, Realm, Password, and either Article name or Article ID.

api_web?r=myrealm&p=mypass&c=getarticlewithid&article_id=42

The command is ‘getarticlewithid’, the realm is ‘myrealm’, the password is ‘mypass’, and the ID is '42'.

api_web?r=myrealm&p=mypass&c=getarticlewithname&article_name=myarticle

The command is ‘getarticlewithname’, the realm is ‘myrealm’, the password is ‘mypass’, and the name is 'myarticle'.

The Get Article commands support the following arguments:

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=[getarticlewithid, getarticlewithname]

c=[getarticlewithid, getarticlewithname]

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm= [realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Version   Version of API to use.  Data may be added to newer versions of the API.  To alleviate issues for users who have already coded file parsing, new columns are only displayed if the version is included.

version=[version_number]

8.4.0 = folder_id

Article  Identification Yes Name or ID of the article to return.  If there are spaces in the name, you can replace the space with + or %20 to avoid possible issues with spaces in a URL.

article_name=[article_name]

or

article_id=[article_id]

Output Format

 

To specify the format of the list output, use one of two arguments.  If no argument is included, the default output is space-delimited plain text string, which may not include all data columns.

csv=1 or

output_format=[csv,csv_tab, csv_pipe,xml]

Header

 

To define the data with a label, use the Header argument.  This can only be used in conjunction with the output format, and does not affect XML.

headers=[0,1]

DEFAULT==0

 

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=getarticlewithid&article_id=42&output_format=csv&headers=1&version=8.4.0

Successful results return:

"Article ID","Name","Title","Article Description","Deck","Callout","Article Body","Author Name","Author Email","Author Bio","Folder ID" "42","myarticle","Title","Description","Deck","Callout","Body content","Author","Email","Bio","9"

If not output format is defined, plain results return:

"Article ID","Article Name" "42","myarticle"

Results

The Get Article commands output either the results of the search or a FAILURE message. 

SUCCESS

The Get Article commands do not explicitly return a Success code.  Instead, it outputs the article data.  Use the Output Format argument to return the results in a specific format. 

FAILURE

A Get Articlecommand will fail for several reasons.  The result format is:

FAILURE: [Reason]  

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk