UPDATE an article

This API is used to update title, body, private, custom_templates and children of articles that are active. Deleted articles cannot be updated. NOTE: Children can only be added and not removed, as of now.

Recipes
🦉
Migrate Article Children
Open Recipe

📘

Update an article's custom fields

To update an article's custom fields, use the ULM with Article ID API. The ULM API has been deprecated, but may be usable if your Alation instance is on-premises or if it's on Alation Cloud Service and Logical Metadata Services hasn't been enabled yet. See the API Release Notes for more information about the deprecation and what it means.

As an alternative, you can migrate your articles to Document Hubs so you can use the Documents API or Custom Field Value API to update custom fields. See Migrate Articles to Document Hubs for more information about migration.

Path Params
integer
required

ID of the article

Body Params
string
required

title of the article

string
required

Body of the article

boolean

Is the article private? (By default, it is public)

custom_templates
array of integers

List of custom-template ID's, which can be obtained from CustomTemplates API call.

custom_templates
children
object

List of children (can be article or table)

boolean

When Agile Approval is enabled, true, on the article. For new Articles, this defaults to false

Responses

Language
Credentials
URL
Choose an example:
application/json