Archive the Primary Version of an Article

Archives the primary version of an article. The actions are defined by the field change you request on the resource. To archive the primary version, use "publishStatus":"Archived". To schedule a date for archiving, use "archiveScheduleDate" : <date>.

URI

1/services/data/v25.0/knowledgeManagement/articleVersions/masterVersions/<versionID>

Formats

JSON, XML

HTTP Method

PATCH

Authentication

Authorization: OAuth accesstoken

Parameters

Parameter Description
publishStatus Publishing status of the article. Use archived.
archiveScheduleDate Date to archive the article.

Input

Archive:

1{
2    "publishStatus":"Archived"
3    }

Schedule for archiving (using GMT date format):

1{
2    "archiveScheduleDate" : "2012-04-19T07:00:00.000+0000"
3    }

Output

HTTP status code 204 is returned when an existing record is updated.