Class CaseManagementApi

Hierarchy

CaseManagementApi

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:2459

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:2475

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:2497

commentCase

commentCase(param: CaseManagementApiCommentCaseRequest, options?: Configuration): Promise<TimelineResponse>
Comment case
Parameters
- param: CaseManagementApiCommentCaseRequest
  
  The request object
- Optional options: Configuration
Returns Promise<TimelineResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:2519

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:2541

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:2562

deleteCaseComment

deleteCaseComment(param: CaseManagementApiDeleteCaseCommentRequest, options?: Configuration): Promise<void>
Delete case comment
Parameters
- param: CaseManagementApiDeleteCaseCommentRequest
  
  The request object
- Optional options: Configuration
Returns Promise<void>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:2583

deleteCaseCustomAttribute

deleteCaseCustomAttribute(param: CaseManagementApiDeleteCaseCustomAttributeRequest, options?: Configuration): Promise<CaseResponse>
Delete custom attribute from case
Parameters
- param: CaseManagementApiDeleteCaseCustomAttributeRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:2605

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:2629

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:2650

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:2671

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:2692

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:2707

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:2731

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:2776

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:2798

updateAttributes

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

updateCaseCustomAttribute

updateCaseCustomAttribute(param: CaseManagementApiUpdateCaseCustomAttributeRequest, options?: Configuration): Promise<CaseResponse>
Update case custom attribute
Parameters
- param: CaseManagementApiUpdateCaseCustomAttributeRequest
  
  The request object
- Optional options: Configuration
Returns Promise<CaseResponse>
- Defined in packages/datadog-api-client-v2/apis/CaseManagementApi.ts:2842

updateCaseDescription

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

updateCaseTitle

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

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:2911

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:2933

Generated using TypeDoc