Class CaseManagementApi

Hierarchy

CaseManagementApi

Index

Constructors

Properties

configuration requestFactory responseProcessor

Methods

archiveCase assignCase createCase createProject deleteProject getCase getProject getProjects searchCases searchCasesWithPagination unarchiveCase unassignCase updatePriority updateStatus

Constructors

constructor

new CaseManagementApi(configuration: Configuration, requestFactory?: CaseManagementApiRequestFactory, responseProcessor?: CaseManagementApiResponseProcessor): CaseManagementApi
Parameters
- configuration: Configuration
- Optional requestFactory: CaseManagementApiRequestFactory
- Optional responseProcessor: CaseManagementApiResponseProcessor
Returns CaseManagementApi
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1576

Properties

`Private` configuration

configuration: Configuration

`Private` requestFactory

requestFactory: CaseManagementApiRequestFactory

`Private` responseProcessor

responseProcessor: CaseManagementApiResponseProcessor

Methods

archiveCase

archiveCase(param: CaseManagementApiArchiveCaseRequest, options?: Configuration): Promise<CaseResponse>
Archive case
Parameters
- param: CaseManagementApiArchiveCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1592

assignCase

assignCase(param: CaseManagementApiAssignCaseRequest, options?: Configuration): Promise<CaseResponse>
Assign case to a user
Parameters
- param: CaseManagementApiAssignCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1614

createCase

createCase(param: CaseManagementApiCreateCaseRequest, options?: Configuration): Promise<CaseResponse>
Create a Case
Parameters
- param: CaseManagementApiCreateCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1636

createProject

createProject(param: CaseManagementApiCreateProjectRequest, options?: Configuration): Promise<ProjectResponse>
Create a project.
Parameters
- param: CaseManagementApiCreateProjectRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ProjectResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1657

deleteProject

deleteProject(param: CaseManagementApiDeleteProjectRequest, options?: Configuration): Promise<void>
Remove a project using the project's id.
Parameters
- param: CaseManagementApiDeleteProjectRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1678

getCase

getCase(param: CaseManagementApiGetCaseRequest, options?: Configuration): Promise<CaseResponse>
Get the details of case by case_id
Parameters
- param: CaseManagementApiGetCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1699

getProject

getProject(param: CaseManagementApiGetProjectRequest, options?: Configuration): Promise<ProjectResponse>
Get the details of a project by project_id.
Parameters
- param: CaseManagementApiGetProjectRequest
  
  The request object
- Optional options: Configuration
Returns Promise<ProjectResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1720

getProjects

getProjects(options?: Configuration): Promise<ProjectsResponse>
Get all projects.
Parameters
- Optional options: Configuration
Returns Promise<ProjectsResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1741

searchCases

searchCases(param?: CaseManagementApiSearchCasesRequest, options?: Configuration): Promise<CasesResponse>
Search cases.
Parameters
- param: CaseManagementApiSearchCasesRequest = {}
  
  The request object
- Optional options: Configuration
Returns Promise<CasesResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1756

searchCasesWithPagination

searchCasesWithPagination(param?: CaseManagementApiSearchCasesRequest, options?: Configuration): AsyncGenerator<Case, any, unknown>
Provide a paginated version of searchCases returning a generator with all the items.
Parameters
- param: CaseManagementApiSearchCasesRequest = {}
- Optional options: Configuration
Returns AsyncGenerator<Case, any, unknown>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1780

unarchiveCase

unarchiveCase(param: CaseManagementApiUnarchiveCaseRequest, options?: Configuration): Promise<CaseResponse>
Unarchive case
Parameters
- param: CaseManagementApiUnarchiveCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1825

unassignCase

unassignCase(param: CaseManagementApiUnassignCaseRequest, options?: Configuration): Promise<CaseResponse>
Unassign case
Parameters
- param: CaseManagementApiUnassignCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1847

updatePriority

updatePriority(param: CaseManagementApiUpdatePriorityRequest, options?: Configuration): Promise<CaseResponse>
Update case priority
Parameters
- param: CaseManagementApiUpdatePriorityRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1869

updateStatus

updateStatus(param: CaseManagementApiUpdateStatusRequest, options?: Configuration): Promise<CaseResponse>
Update case status
Parameters
- param: CaseManagementApiUpdateStatusRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:1891

Generated using TypeDoc