Update article

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/kb/article/{articleId}

Sample URLs

https://{api-url}/api/v2/tenants/client_11/kb/article/KB0000000036

Parameters

All parameters are optional:

Field	Data Type	Description
category	String	Name of the knowledge base category.
subject	String	Defines the subject of the knowledge base article.
content	String	Defines the content of the article.
state	String	Defines the published status of the article. Example: PUBLISH, DRAFT
attachments	String	Defines the details of attachments of the article.
expiryDate	String	Defines the expiry date of the article. Date format: yyyy-MM-ddTHH:mm:ssZ. Example: 2019-07-07T09:19:47 0000 (GMT)
linkedArticles	String	Defines the list of linked articles of the article.

Status code

200 OK

Sample request

{
     "subject" : "Need to update the Kafka Server Details",
     "content" : "Modify the Queirs Ann Data",
       "attachments": [{
         "name": "queries.txt",
         "file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
       }
     ]
   }

Sample response

{
    "id": "KB0000000036",
    "subject": "Need to update the Kafka Server Details",
    "content": "Modify the Queirs Ann Data",
    "createdTime": "2019-05-08T10:55:26+0000",
    "updatedTime": "2019-05-10T05:53:33+0000",
    "createdBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "dev@opsramp.com"
    },
    "updatedBy": {
        "id": "USR0000000003",
        "loginName": "superadmin",
        "lastName": "Admin",
        "firstName": "OpsRamp",
        "email": "dev@opsramp.com",
        "phoneNumber": ""
    },
    "shared": false,
    "category": {
        "id": "KBC0000000018",
        "name": "Cassandra",
        "description": "",
        "path": "My Category>>DataBase>>Cassandra",
        "state": "ACTIVE"
    },
    "state": "PUBLISHED",
    "attachments": [
        {
            "id": 14,
            "name": "2.txt",
            "createdDate": "2019-05-08T10:55:27+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "contentURL": "https://{api-url}/api/v2/tenants/client_11/article/KB0000000036/resources/14"
        },
        {
            "id": 15,
            "name": "1.txt",
            "createdDate": "2019-05-08T10:55:36+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "contentURL": "https://{api-url}/api/v2/tenants/client_11/article/KB0000000036/resources/15"
        },
        {
            "id": 20,
            "name": "bustkt.pdf",
            "createdDate": "2019-05-10T05:53:15+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "john@opsramp.com",
                "phoneNumber": ""
            },
            "contentURL": "https://{api-url}/api/v2/tenants/client_11/article/KB0000000036/resources/20"
        },
        {
            "id": 21,
            "name": "bustkt.pdf",
            "createdDate": "2019-05-10T05:53:33+0000",
            "createdBy": {
                "id": "USR0000000003",
                "loginName": "superadmin",
                "lastName": "Admin",
                "firstName": "OpsRamp",
                "email": "dev@opsramp.com",
                "phoneNumber": ""
            },
            "contentURL": "https://{api-url}/api/v2/tenants/client_11/article/KB0000000036/resources/21"
        },
        {
            "id": 22,
            "name": "queries.txt",
            "createdDate": "2019-05-10T06:01:23+0000",
            "createdBy": {
                "id": "USR0000000002",
                "loginName": "opsramp_api_user",
                "lastName": " ",
                "firstName": "OpsRamp API User",
                "email": "dev@opsramp.com"
            },
            "contentURL": "https://{api-url}/api/v2/tenants/client_11/article/KB0000000036/resources/22"
        }
    ],
    "expiryDate": "2019-07-29T07:00:00+0000",
    "linkedArticles": [
        {
            "id": "KB0000000035",
            "subject": "All Data",
            "shared": false
        }
    ]
}