Skip to main content
Version: 2.2.1

newArticle

This method creates an article in an existing knowledge base, allowing attachments to be added and attributes to be entered. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/knowledgebase/NewArticleRequestType.java
Returnweb/wwwroot/ws/java/knowledgebase/NewArticleResponseType.java

Request:

ID #RequiredDescription
ArticleIDXID # of the new article
KnowledgebaseIDX¹ID # of the knowledge base in which the article will be created
CategoryIDX²ID # of the category that will be associated with the article
ArticleDefaultLanguageDefault language code, according to the "Database encoding" column of the Localization section, in the System Requirements document. When empty, the default knowledge base language will be used.
ResponsibleUserIDID of the user responsible for the article
ArticleLanguageXLanguage code, according to the "Database encoding" column of the Localization section, in the System Requirements document.
ArticleNameXArticle name
ArticleContentXArticle content
FileNameFile name (with extension)
FileContentBinary content of the file
AttachmentNameName of the attachment
SummaryAttachment description
AttributeIDAttribute ID #
AttributeValueAttribute value
info
  • X¹ - Required when the CategoryID field is empty;
  • X² - Required when the KnowledgebaseID field is empty.

Request structure:

<urn:newArticle>
<urn:ArticleData>
<urn:ArticleID>?</urn:ArticleID>
<urn:KnowledgebaseID>?</urn:KnowledgebaseID>
<urn:CategoryID>?</urn:CategoryID>
<urn:ArticleDefaultLanguage>?</urn:ArticleDefaultLanguage>
<urn:ResponsibleUserID>?</urn:ResponsibleUserID>
<urn:ContentList>
<!--1 or more repetitions:-->
<urn:Content>
<urn:ArticleLanguage>?</urn:ArticleLanguage>
<urn:ArticleName>?</urn:ArticleName>
<urn:ArticleContent>?</urn:ArticleContent>
<urn:AttachmentList>
<!--Zero or more repetitions:-->
<urn:Attachment>
<urn:FileName>?</urn:FileName>
<urn:FileContent>?</urn:FileContent>
<urn:AttachmentName>?</urn:AttachmentName>
<urn:Summary>?</urn:Summary>
</urn:Attachment>
</urn:AttachmentList>
</urn:Content>
</urn:ContentList>
<urn:AttributeList>
<!--Zero or more repetitions:-->
<urn:Attribute>
<urn:AttributeID>?</urn:AttributeID>
<!--1 or more repetitions:-->
<urn:AttributeValueList>
<urn:AttributeValue>?</urn:AttributeValue>
</urn:AttributeValueList>
</urn:Attribute>
</urn:AttributeList>
</urn:ArticleData>
</urn:newArticle>

Return:

ID #Description
StatusMethod execution status. Its value may be:
SUCCESS: Method executed successfully
FAILURE: An error occurred during the method execution
CodeMethod return code
DetailMethod return detail.
SUCCESS: The method executed successfully description will be returned
FAILURE: The description of the error that was found will be returned