Create Article — 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.

access_levelenumRequired

Allowed values: externalinternalprivatepublicrestricted

applies_to_partslist of stringsRequired

The parts that the article applies to.

article_typeenumRequired

Allowed values: articlecontent_block

Type of the article.

custom_schema_specobjectRequired

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.

owned_bylist of stringsRequired

The users that own the article.

resourceobjectRequired

statusenumRequired

Allowed values: archiveddraftpublishedreview_needed

Status of the article.

titlestringRequired

Name of the article.

aliaseslist of stringsOptional

The aliases of the article.

authored_bylist of stringsOptional

The authors of the article.

custom_fieldsobjectOptional

Application-defined custom fields.

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_atstringOptionalformat: "date-time"

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.

tagslist of objectsOptional

Tags associated with the article.

Response

Create article response.

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 "access_level": "external", 6 "applies_to_parts": [ 7 "applies_to_parts", 8 "applies_to_parts" 9 ], 10 "article_type": "article", 11 "custom_schema_spec": {}, 12 "owned_by": [ 13 "owned_by", 14 "owned_by" 15 ], 16 "resource": {}, 17 "status": "archived", 18 "title": "title" 19 }'

1 { 2 "article": { 3 "applies_to_parts": [ 4 { 5 "type": "capability", 6 "id": "id", 7 "name": "name", 8 "owned_by": [ 9 { 10 "type": "dev_user", 11 "display_picture": { 12 "file": {}, 13 "id": "id" 14 }, 15 "id": "id", 16 "state": "active", 17 "display_id": "display_id", 18 "display_name": "display_name", 19 "email": "email", 20 "full_name": "full_name" 21 }, 22 { 23 "type": "dev_user", 24 "display_picture": { 25 "file": {}, 26 "id": "id" 27 }, 28 "id": "id", 29 "state": "active", 30 "display_id": "display_id", 31 "display_name": "display_name", 32 "email": "email", 33 "full_name": "full_name" 34 } 35 ], 36 "display_id": "display_id" 37 }, 38 { 39 "type": "capability", 40 "id": "id", 41 "name": "name", 42 "owned_by": [ 43 { 44 "type": "dev_user", 45 "display_picture": { 46 "file": {}, 47 "id": "id" 48 }, 49 "id": "id", 50 "state": "active", 51 "display_id": "display_id", 52 "display_name": "display_name", 53 "email": "email", 54 "full_name": "full_name" 55 }, 56 { 57 "type": "dev_user", 58 "display_picture": { 59 "file": {}, 60 "id": "id" 61 }, 62 "id": "id", 63 "state": "active", 64 "display_id": "display_id", 65 "display_name": "display_name", 66 "email": "email", 67 "full_name": "full_name" 68 } 69 ], 70 "display_id": "display_id" 71 } 72 ], 73 "article_type": "article", 74 "created_by": { 75 "type": "dev_user", 76 "display_picture": { 77 "file": { 78 "type": "type", 79 "name": "name" 80 }, 81 "id": "id", 82 "display_id": "display_id" 83 }, 84 "id": "id", 85 "state": "active", 86 "display_id": "display_id", 87 "display_name": "display_name", 88 "email": "email", 89 "full_name": "full_name" 90 }, 91 "id": "id", 92 "modified_by": { 93 "type": "dev_user", 94 "display_picture": { 95 "file": { 96 "type": "type", 97 "name": "name" 98 }, 99 "id": "id", 100 "display_id": "display_id" 101 }, 102 "id": "id", 103 "state": "active", 104 "display_id": "display_id", 105 "display_name": "display_name", 106 "email": "email", 107 "full_name": "full_name" 108 }, 109 "owned_by": [ 110 { 111 "type": "dev_user", 112 "display_picture": { 113 "file": { 114 "type": "type", 115 "name": "name" 116 }, 117 "id": "id", 118 "display_id": "display_id" 119 }, 120 "id": "id", 121 "state": "active", 122 "display_id": "display_id", 123 "display_name": "display_name", 124 "email": "email", 125 "full_name": "full_name" 126 }, 127 { 128 "type": "dev_user", 129 "display_picture": { 130 "file": { 131 "type": "type", 132 "name": "name" 133 }, 134 "id": "id", 135 "display_id": "display_id" 136 }, 137 "id": "id", 138 "state": "active", 139 "display_id": "display_id", 140 "display_name": "display_name", 141 "email": "email", 142 "full_name": "full_name" 143 } 144 ], 145 "parent": { 146 "id": "id", 147 "display_id": "display_id" 148 }, 149 "resource": { 150 "artifacts": [ 151 { 152 "file": { 153 "type": "type", 154 "name": "name" 155 }, 156 "id": "id", 157 "display_id": "display_id" 158 }, 159 { 160 "file": { 161 "type": "type", 162 "name": "name" 163 }, 164 "id": "id", 165 "display_id": "display_id" 166 } 167 ], 168 "url": "url" 169 }, 170 "scope": { 171 "id": 1000000, 172 "label": "label", 173 "ordinal": 1000000 174 }, 175 "authored_by": [ 176 { 177 "type": "dev_user", 178 "display_picture": { 179 "file": { 180 "type": "type", 181 "name": "name" 182 }, 183 "id": "id", 184 "display_id": "display_id" 185 }, 186 "id": "id", 187 "state": "active", 188 "display_id": "display_id", 189 "display_name": "display_name", 190 "email": "email", 191 "full_name": "full_name" 192 }, 193 { 194 "type": "dev_user", 195 "display_picture": { 196 "file": { 197 "type": "type", 198 "name": "name" 199 }, 200 "id": "id", 201 "display_id": "display_id" 202 }, 203 "id": "id", 204 "state": "active", 205 "display_id": "display_id", 206 "display_name": "display_name", 207 "email": "email", 208 "full_name": "full_name" 209 } 210 ], 211 "created_date": "created_date", 212 "description": "description", 213 "display_id": "display_id", 214 "extracted_content": [ 215 { 216 "file": { 217 "type": "type", 218 "name": "name" 219 }, 220 "id": "id", 221 "display_id": "display_id" 222 }, 223 { 224 "file": { 225 "type": "type", 226 "name": "name" 227 }, 228 "id": "id", 229 "display_id": "display_id" 230 } 231 ], 232 "modified_date": "modified_date", 233 "num_downvotes": 1, 234 "num_upvotes": 1, 235 "rank": "rank", 236 "title": "title" 237 } 238 }

1	curl -X POST https://api.devrev.ai/articles.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"access_level": "external",
6	"applies_to_parts": [
7	"applies_to_parts",
8	"applies_to_parts"
9	],
10	"article_type": "article",
11	"custom_schema_spec": {},
12	"owned_by": [
13	"owned_by",
14	"owned_by"
15	],
16	"resource": {},
17	"status": "archived",
18	"title": "title"
19	}'

1	{
2	"article": {
3	"applies_to_parts": [
4	{
5	"type": "capability",
6	"id": "id",
7	"name": "name",
8	"owned_by": [
9	{
10	"type": "dev_user",
11	"display_picture": {
12	"file": {},
13	"id": "id"
14	},
15	"id": "id",
16	"state": "active",
17	"display_id": "display_id",
18	"display_name": "display_name",
19	"email": "email",
20	"full_name": "full_name"
21	},
22	{
23	"type": "dev_user",
24	"display_picture": {
25	"file": {},
26	"id": "id"
27	},
28	"id": "id",
29	"state": "active",
30	"display_id": "display_id",
31	"display_name": "display_name",
32	"email": "email",
33	"full_name": "full_name"
34	}
35	],
36	"display_id": "display_id"
37	},
38	{
39	"type": "capability",
40	"id": "id",
41	"name": "name",
42	"owned_by": [
43	{
44	"type": "dev_user",
45	"display_picture": {
46	"file": {},
47	"id": "id"
48	},
49	"id": "id",
50	"state": "active",
51	"display_id": "display_id",
52	"display_name": "display_name",
53	"email": "email",
54	"full_name": "full_name"
55	},
56	{
57	"type": "dev_user",
58	"display_picture": {
59	"file": {},
60	"id": "id"
61	},
62	"id": "id",
63	"state": "active",
64	"display_id": "display_id",
65	"display_name": "display_name",
66	"email": "email",
67	"full_name": "full_name"
68	}
69	],
70	"display_id": "display_id"
71	}
72	],
73	"article_type": "article",
74	"created_by": {
75	"type": "dev_user",
76	"display_picture": {
77	"file": {
78	"type": "type",
79	"name": "name"
80	},
81	"id": "id",
82	"display_id": "display_id"
83	},
84	"id": "id",
85	"state": "active",
86	"display_id": "display_id",
87	"display_name": "display_name",
88	"email": "email",
89	"full_name": "full_name"
90	},
91	"id": "id",
92	"modified_by": {
93	"type": "dev_user",
94	"display_picture": {
95	"file": {
96	"type": "type",
97	"name": "name"
98	},
99	"id": "id",
100	"display_id": "display_id"
101	},
102	"id": "id",
103	"state": "active",
104	"display_id": "display_id",
105	"display_name": "display_name",
106	"email": "email",
107	"full_name": "full_name"
108	},
109	"owned_by": [
110	{
111	"type": "dev_user",
112	"display_picture": {
113	"file": {
114	"type": "type",
115	"name": "name"
116	},
117	"id": "id",
118	"display_id": "display_id"
119	},
120	"id": "id",
121	"state": "active",
122	"display_id": "display_id",
123	"display_name": "display_name",
124	"email": "email",
125	"full_name": "full_name"
126	},
127	{
128	"type": "dev_user",
129	"display_picture": {
130	"file": {
131	"type": "type",
132	"name": "name"
133	},
134	"id": "id",
135	"display_id": "display_id"
136	},
137	"id": "id",
138	"state": "active",
139	"display_id": "display_id",
140	"display_name": "display_name",
141	"email": "email",
142	"full_name": "full_name"
143	}
144	],
145	"parent": {
146	"id": "id",
147	"display_id": "display_id"
148	},
149	"resource": {
150	"artifacts": [
151	{
152	"file": {
153	"type": "type",
154	"name": "name"
155	},
156	"id": "id",
157	"display_id": "display_id"
158	},
159	{
160	"file": {
161	"type": "type",
162	"name": "name"
163	},
164	"id": "id",
165	"display_id": "display_id"
166	}
167	],
168	"url": "url"
169	},
170	"scope": {
171	"id": 1000000,
172	"label": "label",
173	"ordinal": 1000000
174	},
175	"authored_by": [
176	{
177	"type": "dev_user",
178	"display_picture": {
179	"file": {
180	"type": "type",
181	"name": "name"
182	},
183	"id": "id",
184	"display_id": "display_id"
185	},
186	"id": "id",
187	"state": "active",
188	"display_id": "display_id",
189	"display_name": "display_name",
190	"email": "email",
191	"full_name": "full_name"
192	},
193	{
194	"type": "dev_user",
195	"display_picture": {
196	"file": {
197	"type": "type",
198	"name": "name"
199	},
200	"id": "id",
201	"display_id": "display_id"
202	},
203	"id": "id",
204	"state": "active",
205	"display_id": "display_id",
206	"display_name": "display_name",
207	"email": "email",
208	"full_name": "full_name"
209	}
210	],
211	"created_date": "created_date",
212	"description": "description",
213	"display_id": "display_id",
214	"extracted_content": [
215	{
216	"file": {
217	"type": "type",
218	"name": "name"
219	},
220	"id": "id",
221	"display_id": "display_id"
222	},
223	{
224	"file": {
225	"type": "type",
226	"name": "name"
227	},
228	"id": "id",
229	"display_id": "display_id"
230	}
231	],
232	"modified_date": "modified_date",
233	"num_downvotes": 1,
234	"num_upvotes": 1,
235	"rank": "rank",
236	"title": "title"
237	}
238	}