Class RulesApi

Hierarchy

RulesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RulesApi(basePath?: string): RulesApi

- Defined in api/api.ts:67458
Parameters
- Optional basePath: string
Returns RulesApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

addProcessWorkItemTypeRule

addProcessWorkItemTypeRule(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessRule>

- Defined in api/api.ts:67475
Adds a rule to work item type in the process.

Parameters
- params: object
  - apiVersion: string
  - body: CreateProcessRuleRequest
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessRule>

deleteProcessWorkItemTypeRule

deleteProcessWorkItemTypeRule(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:67541
Removes a rule from the work item type in the process.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - processId: string
  - ruleId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getProcessWorkItemTypeRule

getProcessWorkItemTypeRule(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessRule>

- Defined in api/api.ts:67605
Returns a single rule in the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - processId: string
  - ruleId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessRule>

getProcessWorkItemTypeRules

getProcessWorkItemTypeRules(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ProcessRule>>

- Defined in api/api.ts:67668
Returns a list of all rules in the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<ProcessRule>>

updateProcessWorkItemTypeRule

updateProcessWorkItemTypeRule(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessRule>

- Defined in api/api.ts:67728
Updates a rule in the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - body: UpdateProcessRuleRequest
  - organization: string
  - processId: string
  - ruleId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessRule>

Generated using TypeDoc