UNPKG

35.5 kBTypeScriptView Raw
1import basem = require('./ClientApiBases');
2import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
3import WorkItemTrackingProcessInterfaces = require("./interfaces/WorkItemTrackingProcessInterfaces");
4export interface IWorkItemTrackingProcessApi extends basem.ClientApiBase {
5 createProcessBehavior(behavior: WorkItemTrackingProcessInterfaces.ProcessBehaviorCreateRequest, processId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior>;
6 deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>;
7 getProcessBehavior(processId: string, behaviorRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior>;
8 getProcessBehaviors(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior[]>;
9 updateProcessBehavior(behaviorData: WorkItemTrackingProcessInterfaces.ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior>;
10 createControlInGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
11 moveControlToGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
12 removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>;
13 updateControl(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
14 addFieldToWorkItemType(field: WorkItemTrackingProcessInterfaces.AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField>;
15 getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField[]>;
16 getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeFieldsExpandLevel): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField>;
17 removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>;
18 updateWorkItemTypeField(field: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField>;
19 addGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
20 moveGroupToPage(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
21 moveGroupToSection(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
22 removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>;
23 updateGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
24 getFormLayout(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.FormLayout>;
25 createList(picklist: WorkItemTrackingProcessInterfaces.PickList): Promise<WorkItemTrackingProcessInterfaces.PickList>;
26 deleteList(listId: string): Promise<void>;
27 getList(listId: string): Promise<WorkItemTrackingProcessInterfaces.PickList>;
28 getListsMetadata(): Promise<WorkItemTrackingProcessInterfaces.PickListMetadata[]>;
29 updateList(picklist: WorkItemTrackingProcessInterfaces.PickList, listId: string): Promise<WorkItemTrackingProcessInterfaces.PickList>;
30 addPage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.Page>;
31 removePage(processId: string, witRefName: string, pageId: string): Promise<void>;
32 updatePage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.Page>;
33 createNewProcess(createRequest: WorkItemTrackingProcessInterfaces.CreateProcessModel): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo>;
34 deleteProcessById(processTypeId: string): Promise<void>;
35 editProcess(updateRequest: WorkItemTrackingProcessInterfaces.UpdateProcessModel, processTypeId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo>;
36 getListOfProcesses(expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo[]>;
37 getProcessByItsId(processTypeId: string, expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo>;
38 addProcessWorkItemTypeRule(processRuleCreate: WorkItemTrackingProcessInterfaces.CreateProcessRuleRequest, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule>;
39 deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>;
40 getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule>;
41 getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule[]>;
42 updateProcessWorkItemTypeRule(processRule: WorkItemTrackingProcessInterfaces.UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule>;
43 createStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
44 deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>;
45 getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
46 getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel[]>;
47 hideStateDefinition(hideStateModel: WorkItemTrackingProcessInterfaces.HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
48 updateStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
49 deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<WorkItemTrackingProcessInterfaces.Control[]>;
50 getSystemControls(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.Control[]>;
51 updateSystemControl(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, controlId: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
52 createProcessWorkItemType(workItemType: WorkItemTrackingProcessInterfaces.CreateProcessWorkItemTypeRequest, processId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType>;
53 deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>;
54 getProcessWorkItemType(processId: string, witRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType>;
55 getProcessWorkItemTypes(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType[]>;
56 updateProcessWorkItemType(workItemTypeUpdate: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType>;
57 addBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior>;
58 getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior>;
59 getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior[]>;
60 removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>;
61 updateBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior>;
62}
63export declare class WorkItemTrackingProcessApi extends basem.ClientApiBase implements IWorkItemTrackingProcessApi {
64 constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
65 static readonly RESOURCE_AREA_ID = "5264459e-e5e0-4bd8-b118-0985e68a4ec5";
66 /**
67 * Creates a single behavior in the given process.
68 *
69 * @param {WorkItemTrackingProcessInterfaces.ProcessBehaviorCreateRequest} behavior
70 * @param {string} processId - The ID of the process
71 */
72 createProcessBehavior(behavior: WorkItemTrackingProcessInterfaces.ProcessBehaviorCreateRequest, processId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior>;
73 /**
74 * Removes a behavior in the process.
75 *
76 * @param {string} processId - The ID of the process
77 * @param {string} behaviorRefName - The reference name of the behavior
78 */
79 deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>;
80 /**
81 * Returns a behavior of the process.
82 *
83 * @param {string} processId - The ID of the process
84 * @param {string} behaviorRefName - The reference name of the behavior
85 * @param {WorkItemTrackingProcessInterfaces.GetBehaviorsExpand} expand
86 */
87 getProcessBehavior(processId: string, behaviorRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior>;
88 /**
89 * Returns a list of all behaviors in the process.
90 *
91 * @param {string} processId - The ID of the process
92 * @param {WorkItemTrackingProcessInterfaces.GetBehaviorsExpand} expand
93 */
94 getProcessBehaviors(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetBehaviorsExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior[]>;
95 /**
96 * Replaces a behavior in the process.
97 *
98 * @param {WorkItemTrackingProcessInterfaces.ProcessBehaviorUpdateRequest} behaviorData
99 * @param {string} processId - The ID of the process
100 * @param {string} behaviorRefName - The reference name of the behavior
101 */
102 updateProcessBehavior(behaviorData: WorkItemTrackingProcessInterfaces.ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessBehavior>;
103 /**
104 * Creates a control in a group.
105 *
106 * @param {WorkItemTrackingProcessInterfaces.Control} control - The control.
107 * @param {string} processId - The ID of the process.
108 * @param {string} witRefName - The reference name of the work item type.
109 * @param {string} groupId - The ID of the group to add the control to.
110 */
111 createControlInGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
112 /**
113 * Moves a control to a specified group.
114 *
115 * @param {WorkItemTrackingProcessInterfaces.Control} control - The control.
116 * @param {string} processId - The ID of the process.
117 * @param {string} witRefName - The reference name of the work item type.
118 * @param {string} groupId - The ID of the group to move the control to.
119 * @param {string} controlId - The ID of the control.
120 * @param {string} removeFromGroupId - The group ID to remove the control from.
121 */
122 moveControlToGroup(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
123 /**
124 * Removes a control from the work item form.
125 *
126 * @param {string} processId - The ID of the process.
127 * @param {string} witRefName - The reference name of the work item type.
128 * @param {string} groupId - The ID of the group.
129 * @param {string} controlId - The ID of the control to remove.
130 */
131 removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>;
132 /**
133 * Updates a control on the work item form.
134 *
135 * @param {WorkItemTrackingProcessInterfaces.Control} control - The updated control.
136 * @param {string} processId - The ID of the process.
137 * @param {string} witRefName - The reference name of the work item type.
138 * @param {string} groupId - The ID of the group.
139 * @param {string} controlId - The ID of the control.
140 */
141 updateControl(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
142 /**
143 * Adds a field to a work item type.
144 *
145 * @param {WorkItemTrackingProcessInterfaces.AddProcessWorkItemTypeFieldRequest} field
146 * @param {string} processId - The ID of the process.
147 * @param {string} witRefName - The reference name of the work item type.
148 */
149 addFieldToWorkItemType(field: WorkItemTrackingProcessInterfaces.AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField>;
150 /**
151 * Returns a list of all fields in a work item type.
152 *
153 * @param {string} processId - The ID of the process.
154 * @param {string} witRefName - The reference name of the work item type.
155 */
156 getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField[]>;
157 /**
158 * Returns a field in a work item type.
159 *
160 * @param {string} processId - The ID of the process.
161 * @param {string} witRefName - The reference name of the work item type.
162 * @param {string} fieldRefName - The reference name of the field.
163 * @param {WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeFieldsExpandLevel} expand
164 */
165 getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeFieldsExpandLevel): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField>;
166 /**
167 * Removes a field from a work item type. Does not permanently delete the field.
168 *
169 * @param {string} processId - The ID of the process.
170 * @param {string} witRefName - The reference name of the work item type.
171 * @param {string} fieldRefName - The reference name of the field.
172 */
173 removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>;
174 /**
175 * Updates a field in a work item type.
176 *
177 * @param {WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeFieldRequest} field
178 * @param {string} processId - The ID of the process.
179 * @param {string} witRefName - The reference name of the work item type.
180 * @param {string} fieldRefName - The reference name of the field.
181 */
182 updateWorkItemTypeField(field: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemTypeField>;
183 /**
184 * Adds a group to the work item form.
185 *
186 * @param {WorkItemTrackingProcessInterfaces.Group} group - The group.
187 * @param {string} processId - The ID of the process.
188 * @param {string} witRefName - The reference name of the work item type.
189 * @param {string} pageId - The ID of the page to add the group to.
190 * @param {string} sectionId - The ID of the section to add the group to.
191 */
192 addGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
193 /**
194 * Moves a group to a different page and section.
195 *
196 * @param {WorkItemTrackingProcessInterfaces.Group} group - The updated group.
197 * @param {string} processId - The ID of the process.
198 * @param {string} witRefName - The reference name of the work item type.
199 * @param {string} pageId - The ID of the page the group is in.
200 * @param {string} sectionId - The ID of the section the group is i.n
201 * @param {string} groupId - The ID of the group.
202 * @param {string} removeFromPageId - ID of the page to remove the group from.
203 * @param {string} removeFromSectionId - ID of the section to remove the group from.
204 */
205 moveGroupToPage(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
206 /**
207 * Moves a group to a different section.
208 *
209 * @param {WorkItemTrackingProcessInterfaces.Group} group - The updated group.
210 * @param {string} processId - The ID of the process.
211 * @param {string} witRefName - The reference name of the work item type.
212 * @param {string} pageId - The ID of the page the group is in.
213 * @param {string} sectionId - The ID of the section the group is in.
214 * @param {string} groupId - The ID of the group.
215 * @param {string} removeFromSectionId - ID of the section to remove the group from.
216 */
217 moveGroupToSection(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
218 /**
219 * Removes a group from the work item form.
220 *
221 * @param {string} processId - The ID of the process
222 * @param {string} witRefName - The reference name of the work item type
223 * @param {string} pageId - The ID of the page the group is in
224 * @param {string} sectionId - The ID of the section to the group is in
225 * @param {string} groupId - The ID of the group
226 */
227 removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>;
228 /**
229 * Updates a group in the work item form.
230 *
231 * @param {WorkItemTrackingProcessInterfaces.Group} group - The updated group.
232 * @param {string} processId - The ID of the process.
233 * @param {string} witRefName - The reference name of the work item type.
234 * @param {string} pageId - The ID of the page the group is in.
235 * @param {string} sectionId - The ID of the section the group is in.
236 * @param {string} groupId - The ID of the group.
237 */
238 updateGroup(group: WorkItemTrackingProcessInterfaces.Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<WorkItemTrackingProcessInterfaces.Group>;
239 /**
240 * Gets the form layout.
241 *
242 * @param {string} processId - The ID of the process.
243 * @param {string} witRefName - The reference name of the work item type.
244 */
245 getFormLayout(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.FormLayout>;
246 /**
247 * Creates a picklist.
248 *
249 * @param {WorkItemTrackingProcessInterfaces.PickList} picklist - Picklist
250 */
251 createList(picklist: WorkItemTrackingProcessInterfaces.PickList): Promise<WorkItemTrackingProcessInterfaces.PickList>;
252 /**
253 * Removes a picklist.
254 *
255 * @param {string} listId - The ID of the list
256 */
257 deleteList(listId: string): Promise<void>;
258 /**
259 * Returns a picklist.
260 *
261 * @param {string} listId - The ID of the list
262 */
263 getList(listId: string): Promise<WorkItemTrackingProcessInterfaces.PickList>;
264 /**
265 * Returns meta data of the picklist.
266 *
267 */
268 getListsMetadata(): Promise<WorkItemTrackingProcessInterfaces.PickListMetadata[]>;
269 /**
270 * Updates a list.
271 *
272 * @param {WorkItemTrackingProcessInterfaces.PickList} picklist
273 * @param {string} listId - The ID of the list
274 */
275 updateList(picklist: WorkItemTrackingProcessInterfaces.PickList, listId: string): Promise<WorkItemTrackingProcessInterfaces.PickList>;
276 /**
277 * Adds a page to the work item form.
278 *
279 * @param {WorkItemTrackingProcessInterfaces.Page} page - The page.
280 * @param {string} processId - The ID of the process.
281 * @param {string} witRefName - The reference name of the work item type.
282 */
283 addPage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.Page>;
284 /**
285 * Removes a page from the work item form
286 *
287 * @param {string} processId - The ID of the process
288 * @param {string} witRefName - The reference name of the work item type
289 * @param {string} pageId - The ID of the page
290 */
291 removePage(processId: string, witRefName: string, pageId: string): Promise<void>;
292 /**
293 * Updates a page on the work item form
294 *
295 * @param {WorkItemTrackingProcessInterfaces.Page} page - The page
296 * @param {string} processId - The ID of the process
297 * @param {string} witRefName - The reference name of the work item type
298 */
299 updatePage(page: WorkItemTrackingProcessInterfaces.Page, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.Page>;
300 /**
301 * Creates a process.
302 *
303 * @param {WorkItemTrackingProcessInterfaces.CreateProcessModel} createRequest - CreateProcessModel.
304 */
305 createNewProcess(createRequest: WorkItemTrackingProcessInterfaces.CreateProcessModel): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo>;
306 /**
307 * Removes a process of a specific ID.
308 *
309 * @param {string} processTypeId
310 */
311 deleteProcessById(processTypeId: string): Promise<void>;
312 /**
313 * Edit a process of a specific ID.
314 *
315 * @param {WorkItemTrackingProcessInterfaces.UpdateProcessModel} updateRequest
316 * @param {string} processTypeId
317 */
318 editProcess(updateRequest: WorkItemTrackingProcessInterfaces.UpdateProcessModel, processTypeId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo>;
319 /**
320 * Get list of all processes including system and inherited.
321 *
322 * @param {WorkItemTrackingProcessInterfaces.GetProcessExpandLevel} expand
323 */
324 getListOfProcesses(expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo[]>;
325 /**
326 * Get a single process of a specified ID.
327 *
328 * @param {string} processTypeId
329 * @param {WorkItemTrackingProcessInterfaces.GetProcessExpandLevel} expand
330 */
331 getProcessByItsId(processTypeId: string, expand?: WorkItemTrackingProcessInterfaces.GetProcessExpandLevel): Promise<WorkItemTrackingProcessInterfaces.ProcessInfo>;
332 /**
333 * Adds a rule to work item type in the process.
334 *
335 * @param {WorkItemTrackingProcessInterfaces.CreateProcessRuleRequest} processRuleCreate
336 * @param {string} processId - The ID of the process
337 * @param {string} witRefName - The reference name of the work item type
338 */
339 addProcessWorkItemTypeRule(processRuleCreate: WorkItemTrackingProcessInterfaces.CreateProcessRuleRequest, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule>;
340 /**
341 * Removes a rule from the work item type in the process.
342 *
343 * @param {string} processId - The ID of the process
344 * @param {string} witRefName - The reference name of the work item type
345 * @param {string} ruleId - The ID of the rule
346 */
347 deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>;
348 /**
349 * Returns a single rule in the work item type of the process.
350 *
351 * @param {string} processId - The ID of the process
352 * @param {string} witRefName - The reference name of the work item type
353 * @param {string} ruleId - The ID of the rule
354 */
355 getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule>;
356 /**
357 * Returns a list of all rules in the work item type of the process.
358 *
359 * @param {string} processId - The ID of the process
360 * @param {string} witRefName - The reference name of the work item type
361 */
362 getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule[]>;
363 /**
364 * Updates a rule in the work item type of the process.
365 *
366 * @param {WorkItemTrackingProcessInterfaces.UpdateProcessRuleRequest} processRule
367 * @param {string} processId - The ID of the process
368 * @param {string} witRefName - The reference name of the work item type
369 * @param {string} ruleId - The ID of the rule
370 */
371 updateProcessWorkItemTypeRule(processRule: WorkItemTrackingProcessInterfaces.UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessRule>;
372 /**
373 * Creates a state definition in the work item type of the process.
374 *
375 * @param {WorkItemTrackingProcessInterfaces.WorkItemStateInputModel} stateModel
376 * @param {string} processId - The ID of the process
377 * @param {string} witRefName - The reference name of the work item type
378 */
379 createStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
380 /**
381 * Removes a state definition in the work item type of the process.
382 *
383 * @param {string} processId - ID of the process
384 * @param {string} witRefName - The reference name of the work item type
385 * @param {string} stateId - ID of the state
386 */
387 deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>;
388 /**
389 * Returns a single state definition in a work item type of the process.
390 *
391 * @param {string} processId - The ID of the process
392 * @param {string} witRefName - The reference name of the work item type
393 * @param {string} stateId - The ID of the state
394 */
395 getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
396 /**
397 * Returns a list of all state definitions in a work item type of the process.
398 *
399 * @param {string} processId - The ID of the process
400 * @param {string} witRefName - The reference name of the work item type
401 */
402 getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel[]>;
403 /**
404 * Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden.
405 *
406 * @param {WorkItemTrackingProcessInterfaces.HideStateModel} hideStateModel
407 * @param {string} processId - The ID of the process
408 * @param {string} witRefName - The reference name of the work item type
409 * @param {string} stateId - The ID of the state
410 */
411 hideStateDefinition(hideStateModel: WorkItemTrackingProcessInterfaces.HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
412 /**
413 * Updates a given state definition in the work item type of the process.
414 *
415 * @param {WorkItemTrackingProcessInterfaces.WorkItemStateInputModel} stateModel
416 * @param {string} processId - ID of the process
417 * @param {string} witRefName - The reference name of the work item type
418 * @param {string} stateId - ID of the state
419 */
420 updateStateDefinition(stateModel: WorkItemTrackingProcessInterfaces.WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemStateResultModel>;
421 /**
422 * Deletes a system control modification on the work item form.
423 *
424 * @param {string} processId - The ID of the process.
425 * @param {string} witRefName - The reference name of the work item type.
426 * @param {string} controlId - The ID of the control.
427 */
428 deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<WorkItemTrackingProcessInterfaces.Control[]>;
429 /**
430 * Gets edited system controls for a work item type in a process. To get all system controls (base + edited) use layout API(s)
431 *
432 * @param {string} processId - The ID of the process.
433 * @param {string} witRefName - The reference name of the work item type.
434 */
435 getSystemControls(processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.Control[]>;
436 /**
437 * Updates/adds a system control on the work item form.
438 *
439 * @param {WorkItemTrackingProcessInterfaces.Control} control
440 * @param {string} processId - The ID of the process.
441 * @param {string} witRefName - The reference name of the work item type.
442 * @param {string} controlId - The ID of the control.
443 */
444 updateSystemControl(control: WorkItemTrackingProcessInterfaces.Control, processId: string, witRefName: string, controlId: string): Promise<WorkItemTrackingProcessInterfaces.Control>;
445 /**
446 * Creates a work item type in the process.
447 *
448 * @param {WorkItemTrackingProcessInterfaces.CreateProcessWorkItemTypeRequest} workItemType
449 * @param {string} processId - The ID of the process on which to create work item type.
450 */
451 createProcessWorkItemType(workItemType: WorkItemTrackingProcessInterfaces.CreateProcessWorkItemTypeRequest, processId: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType>;
452 /**
453 * Removes a work item type in the process.
454 *
455 * @param {string} processId - The ID of the process.
456 * @param {string} witRefName - The reference name of the work item type.
457 */
458 deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>;
459 /**
460 * Returns a single work item type in a process.
461 *
462 * @param {string} processId - The ID of the process
463 * @param {string} witRefName - The reference name of the work item type
464 * @param {WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand} expand - Flag to determine what properties of work item type to return
465 */
466 getProcessWorkItemType(processId: string, witRefName: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType>;
467 /**
468 * Returns a list of all work item types in a process.
469 *
470 * @param {string} processId - The ID of the process
471 * @param {WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand} expand - Flag to determine what properties of work item type to return
472 */
473 getProcessWorkItemTypes(processId: string, expand?: WorkItemTrackingProcessInterfaces.GetWorkItemTypeExpand): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType[]>;
474 /**
475 * Updates a work item type of the process.
476 *
477 * @param {WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeRequest} workItemTypeUpdate
478 * @param {string} processId - The ID of the process
479 * @param {string} witRefName - The reference name of the work item type
480 */
481 updateProcessWorkItemType(workItemTypeUpdate: WorkItemTrackingProcessInterfaces.UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<WorkItemTrackingProcessInterfaces.ProcessWorkItemType>;
482 /**
483 * Adds a behavior to the work item type of the process.
484 *
485 * @param {WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior} behavior
486 * @param {string} processId - The ID of the process
487 * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior
488 */
489 addBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior>;
490 /**
491 * Returns a behavior for the work item type of the process.
492 *
493 * @param {string} processId - The ID of the process
494 * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior
495 * @param {string} behaviorRefName - The reference name of the behavior
496 */
497 getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior>;
498 /**
499 * Returns a list of all behaviors for the work item type of the process.
500 *
501 * @param {string} processId - The ID of the process
502 * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior
503 */
504 getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior[]>;
505 /**
506 * Removes a behavior for the work item type of the process.
507 *
508 * @param {string} processId - The ID of the process
509 * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior
510 * @param {string} behaviorRefName - The reference name of the behavior
511 */
512 removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>;
513 /**
514 * Updates a behavior for the work item type of the process.
515 *
516 * @param {WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior} behavior
517 * @param {string} processId - The ID of the process
518 * @param {string} witRefNameForBehaviors - Work item type reference name for the behavior
519 */
520 updateBehaviorToWorkItemType(behavior: WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTrackingProcessInterfaces.WorkItemTypeBehavior>;
521}