Create article

This endpoint is used to create a knowledge base article.

Leave Feedback

URL

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

Sample URLs

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

Parameters

FieldData TypeDescription
categoryStringName of the knowledge base category.
subjectStringDefines the subject of the knowledge base article.
contentStringDefines the content of the article.
stateString(Optional) Defines the published status of the article.
Example: PUBLISH, DRAFT
attachmentsString(Optional) Defines the details of attachments of the article.
expiryDateString(Optional) Defines the expiry date of the article.
Date format: yyyy-MM-ddTHH:mm:ssZ.
Example: 2019-07-07T09:19:47 0000 (GMT)
linkedArticlesString(Optional) Defines the list of linked articles of the article.

Status code

200 OK

Sample request

{
      "subject" : "Database Details",
      "content" : "Database Details",
      "category": {
        	"id": "KBC0000000018"
    	}
}

Sample response

{
    "id": "KB0000000036",
    "subject": "Database Details",
    "content": "Database Details",
    "createdTime": "2019-05-08T10:55:26+0000",
    "updatedTime": "2019-05-08T10:55:26+0000",
    "createdBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "john@opsramp.com"
    },
    "updatedBy": {
        "id": "USR0000000002",
        "loginName": "opsramp_api_user",
        "lastName": " ",
        "firstName": "OpsRamp API User",
        "email": "john@opsramp.com"
    },
    "shared": false,
    "category": {
        "id": "KBC0000000018",
        "name": "Cassandra",
        "description": "",
        "path": "My Category>>DataBase>>Cassandra",
        "state": "ACTIVE"
    },
    "state": "PUBLISHED",
    "linkedArticles" : [
    	{
		"id": "KB0000000035"
	}
    ],
    "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.opsramp.com/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.opsramp.com/api/v2/tenants/client_11/article/KB0000000036/resources/15"
        }
    ],
    "expiryDate": "2019-05-30T00:00:00+0000",
    "linkedArticles": [
        {
            "id": "KB0000000035",
            "subject": "All Data",
            "sharedArticle": false
        }
    ]
}