Create Article (Beta) — DevRev

Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.

Request

This endpoint expects an object.

applies_to_partslist of stringsRequired

The parts that the article applies to.

owned_bylist of stringsRequired

The users that own the article.

resourceobjectRequired

titlestringRequired

Name of the article.

access_levelenumOptional

Allowed values: externalinternalprivatepublicrestricted

article_type"article" or "content_block"Optional

Allowed values: articlecontent_block

Type of the article.

authored_bylist of stringsOptional

The authors of the article.

custom_fieldsmap from strings to anyOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

descriptionstringOptional

Description for the article.

extracted_contentlist of stringsOptional

ID of the extracted content artifact.

languagestringOptional

Language of the article.

parentstringOptional

The parent directory of the article.

published_atdatetimeOptional

The published date of the article.

scopelongOptional

The scope of the article.

shared_withlist of objectsOptional

Information about the role the member receives due to the share.

statusenumOptional

Allowed values: archiveddraftpublishedreview_needed

Status of the article.

tagslist of objectsOptional

Tags associated with the article.

Response

This endpoint returns an object.

articleobject

1	curl -X POST https://api.devrev.ai/articles.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"applies_to_parts": [
6	"PROD-12345"
7	],
8	"owned_by": [
9	"DEVU-12345"
10	],
11	"resource": {},
12	"title": "title"
13	}'

1	{
2	"article": {
3	"applies_to_parts": [],
4	"id": "id",
5	"owned_by": [],
6	"article_type": "article",
7	"created_date": "2023-01-01T12:00:00Z",
8	"description": "description",
9	"display_id": "display_id",
10	"extracted_content": [
11	{
12	"id": "id"
13	}
14	],
15	"modified_date": "2023-01-01T12:00:00Z",
16	"num_downvotes": 1,
17	"num_upvotes": 1,
18	"parent": {
19	"id": "id",
20	"display_id": "display_id"
21	},
22	"rank": "rank",
23	"resource": {
24	"artifacts": [
25	{
26	"id": "id"
27	}
28	],
29	"url": "url"
30	},
31	"scope": {
32	"id": 1000000,
33	"label": "label",
34	"ordinal": 1000000
35	},
36	"title": "title"
37	}
38	}