API: HTTP Show Articles
The Show Articles command allows you to return a list of Articles in your realm. This command returns the article id and name of each article in the realm, sorted alphabetically by article name.
Arguments
Show Articles requires the following arguments: Command, Realm, and Password.
api_web?r=myrealm&p=mypass&c=showarticlelist
The command is ‘showarticlelist’, the realm is ‘myrealm’ and the password is ‘mypass’.
The Show Articles command supports the following arguments:
Name | Req? | Description | Argument |
Command | Yes | Defines the command to use. | cmd=showarticlelist c=showarticlelist |
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 |
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=showarticlelist&output_format=csv&headers=1&version=8.4.0
Successful results return:
"Article Number","Name","Article Description","Folder ID" "1","Article A","Plain Text","0" "2","Article B","Simple content","1" "3","Article C","","6" "4","Article D","HTML","98"
Results
The Show Articles command outputs either the results of the search or a FAILURE message.
SUCCESS
The Show Articles command does not explicitly return a Success code. Instead, it outputs the article id and name in plain text format. Use the Output Format argument to return the results in an alternate format.
FAILURE
A Show Articles command will fail for several reasons. The result format is:
FAILURE: [Reason]