.WorkflowApi

All URIs are relative to http://localhost

Method	HTTP request	Description
workflowCreateCase	POST /api/v3/cases	Summary: Create case Description: Create single case.
workflowCreateProductEntity	POST /api/v3/workflow/productentities	Summary: Create product entity Description: Create single product entity.
workflowCreateTask	POST /api/v3/cases/{case_id}/tasks	Summary: Create task Description: Create single task within a parent case.
workflowCreateWorkflowEvent	POST /api/v3/workflow/event	Summary: Post event for processing by workflow rules Description: Find matching workflow rule and run it
workflowDeleteProductEntity	DELETE /api/v3/workflow/productentities/{entity_id}	Summary: Delete a product entity Description: Delete a single product entity.
workflowGetCases	GET /api/v3/cases	Summary: Get cases Description: Return all cases requested.
workflowGetCasesCount	POST /api/v3/cases/count	Summary: Get cases count Description: Get case count.
workflowGetFilename	GET /api/v3/cases/{case_id}/tasks/{task_id}/filename	Summary: Get filename Description: Return filename associated with the task referenced in the associated context record.
workflowGetJobsCount	POST /api/v3/cases/{case_id}/jobs/count	Summary: Get jobs count Description: Get jobs count.
workflowGetProductEntities	GET /api/v3/workflow/productentities	Summary: Get products and their associated event entities Description: Return a list of integrated products and their associated event entities
workflowGetProductEntity	GET /api/v3/workflow/productentities/{entity_id}	Summary: Get event entity field names, field labels, and field data types Description: Return a list of fields similar to report headers
workflowGetReportResult	GET /api/v3/cases/{case_id}/tasks/{task_id}/result	Summary: Get report result Description: Return a page of results.
workflowGetTasks	GET /api/v3/cases/{case_id}/tasks	Summary: Get tasks Description: Return all tasks requested.
workflowGetTasksCount	POST /api/v3/cases/{case_id}/tasks/count	Summary: Get cases count Description: Get case count.
workflowSearchCases	POST /api/v3/cases/search	Summary: Search cases Description: Return a subset of cases.
workflowSearchReports	POST /api/v3/cases/reports	Summary: Get a list of report IDs Description: Returns a list of report IDs referenced in all cases and tasks
workflowSearchTasks	POST /api/v3/cases/{case_id}/tasks/search	Summary: Search cases Description: Return a subset of cases.
workflowUpdateCases	PUT /api/v3/cases	Summary: Update cases Description: Update multiple cases in one request.
workflowUpdateProductEntity	PUT /api/v3/workflow/productentities/{entity_id}	Summary: Update a product entity Description: Update a single product entity.
workflowUpdateTasks	PUT /api/v3/cases/{case_id}/tasks	Summary: Update tasks Description: Update multiple tasks for the same parent in one request.

workflowCreateCase

Workflowv3CreateCaseResponse workflowCreateCase(workflowv3CreateCaseRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowCreateCaseRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowCreateCaseRequest = {
  
  workflowv3CreateCaseRequest: {
    _case: {
      artifacts: [
        "artifacts_example",
      ],
      assignments: [
        {
          label: "label_example",
          templateId: "templateId_example",
          type: "UNDEFINED_ENTITY_TYPE",
          value: "value_example",
        },
      ],
      caseId: "caseId_example",
      comment: "comment_example",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      description: "description_example",
      priority: "UNDEFINED_PRIORITY",
      status: "UNDEFINED_STATUS",
      title: "title_example",
    },
  },
};

const data = await apiInstance.workflowCreateCase(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3CreateCaseRequest	Workflowv3CreateCaseRequest

Return type

Workflowv3CreateCaseResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowCreateProductEntity

Workflowv3CreateProductEntityResponse workflowCreateProductEntity(workflowv3ProductEntity)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowCreateProductEntityRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowCreateProductEntityRequest = {
  
  workflowv3ProductEntity: {
    entity: {
      disabled: true,
      entityId: "entityId_example",
      entityLabel: "entityLabel_example",
      featureFlag: "featureFlag_example",
      preventDelete: true,
      privilegeId: "privilegeId_example",
      privilegeType: "privilegeType_example",
      productId: "productId_example",
      productLabel: "productLabel_example",
      templateOrigin: "templateOrigin_example",
      workflow: {
        auditType: "UNDEFINED_TYPE",
        configTypes: [
          "configTypes_example",
        ],
        workflowInvestigationLinks: [
          {
            display: "display_example",
            id: "id_example",
            type: "type_example",
          },
        ],
        workflowResponseTemplate: {
          display: "display_example",
          id: "id_example",
          type: "type_example",
        },
        workflowUniqueFields: [
          "workflowUniqueFields_example",
        ],
      },
    },
    headers: [
      {
        choices: [
          {
            disabled: true,
            label: "label_example",
            name: "name_example",
          },
        ],
        groupTypeId: 1,
        hideFromView: true,
        key: "key_example",
        type: "STRING",
        value: "value_example",
      },
    ],
  },
};

const data = await apiInstance.workflowCreateProductEntity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3ProductEntity	Workflowv3ProductEntity

Return type

Workflowv3CreateProductEntityResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowCreateTask

Workflowv3CreateTaskResponse workflowCreateTask(workflowv3CreateTaskRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowCreateTaskRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowCreateTaskRequest = {
    // Create tasks with common parent.
  caseId: "case_id_example",
  
  workflowv3CreateTaskRequest: {
    caseId: "caseId_example",
    task: {
      altId: "altId_example",
      assignments: [
        {
          label: "label_example",
          templateId: "templateId_example",
          type: "UNDEFINED_ENTITY_TYPE",
          value: "value_example",
        },
      ],
      comment: "comment_example",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dependsOn: [
        "dependsOn_example",
      ],
      description: "description_example",
      investigationLinks: [
        {
          display: "display_example",
          id: "id_example",
          type: "type_example",
        },
      ],
      origin: {
        dateNext: new Date('1970-01-01T00:00:00.00Z'),
        dateStart: new Date('1970-01-01T00:00:00.00Z'),
        description: "description_example",
        frequency: "frequency_example",
        name: "name_example",
        scheduledJobId: "scheduledJobId_example",
      },
      priority: "UNDEFINED_PRIORITY",
      reportResult: {
        headers: [
          {
            header: "header_example",
            key: "key_example",
          },
        ],
        rows: [
          {
            row: {
              "key": "key_example",
            },
          },
        ],
      },
      responseTemplate: {
        display: "display_example",
        id: "id_example",
        type: "type_example",
      },
      status: "UNDEFINED_STATUS",
      tags: [
        "tags_example",
      ],
      title: "title_example",
    },
  },
};

const data = await apiInstance.workflowCreateTask(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3CreateTaskRequest	Workflowv3CreateTaskRequest
caseId	[string]	Create tasks with common parent.	defaults to undefined

Return type

Workflowv3CreateTaskResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowCreateWorkflowEvent

Workflowv3WorkflowEventResponse workflowCreateWorkflowEvent(workflowv3WorkflowEvent)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowCreateWorkflowEventRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowCreateWorkflowEventRequest = {
  
  workflowv3WorkflowEvent: {
    data: {
      "key": "key_example",
    },
    entityId: "entityId_example",
    href: "href_example",
    severity: "UNDEFINED_PRIORITY",
    tenantId: "tenantId_example",
    title: "title_example",
  },
};

const data = await apiInstance.workflowCreateWorkflowEvent(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3WorkflowEvent	Workflowv3WorkflowEvent

Return type

Workflowv3WorkflowEventResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowDeleteProductEntity

Workflowv3DeleteProductEntityResponse workflowDeleteProductEntity()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowDeleteProductEntityRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowDeleteProductEntityRequest = {
    // Unique id for the product entity
  entityId: "entity_id_example",
};

const data = await apiInstance.workflowDeleteProductEntity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
entityId	[string]	Unique id for the product entity	defaults to undefined

Return type

Workflowv3DeleteProductEntityResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetCases

Workflowv3CaseListResponse workflowGetCases()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetCasesRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetCasesRequest = {
    // Optional case_id to get a response of an array of one member. (optional)
  caseId: "case_id_example",
    // Optional field to sort by | first character determines ascending (>) or descending (<). (optional)
  sortBy: "sort_by_example",
    // Optional starting point for the page of data. (optional)
  offset: 1,
    // Optional page size. (optional)
  limit: 1,
};

const data = await apiInstance.workflowGetCases(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
caseId	[string]	Optional case_id to get a response of an array of one member.	(optional) defaults to undefined
sortBy	[string]	Optional field to sort by	first character determines ascending (>) or descending (<).
offset	[number]	Optional starting point for the page of data.	(optional) defaults to undefined
limit	[number]	Optional page size.	(optional) defaults to undefined

Return type

Workflowv3CaseListResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetCasesCount

Workflowv3GetCasesCountResponse workflowGetCasesCount(workflowv3GetCasesCountRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetCasesCountRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetCasesCountRequest = {
  
  workflowv3GetCasesCountRequest: {
    filter: {
      assignedToMe: true,
      assignedToMyRoles: true,
      dateCreated: new Date('1970-01-01T00:00:00.00Z'),
      dateCreatedOperator: "IGNORE",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dateDueOperator: "IGNORE",
      filterColumns: [
        {
          headerName: "headerName_example",
          operatorType: "UNDEFINED_OPERATOR_TYPE",
          values: [
            "values_example",
          ],
        },
      ],
      priority: "UNDEFINED_PRIORITY",
      priorityOperator: "IGNORE",
      reportId: "reportId_example",
      scheduledJobId: [
        "scheduledJobId_example",
      ],
      scheduledTaskId: [
        "scheduledTaskId_example",
      ],
      status: "UNDEFINED_STATUS",
      statusOperator: "IGNORE",
      tags: [
        "tags_example",
      ],
    },
  },
};

const data = await apiInstance.workflowGetCasesCount(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3GetCasesCountRequest	Workflowv3GetCasesCountRequest

Return type

Workflowv3GetCasesCountResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetFilename

Workflowv3GetFilenameResponse workflowGetFilename()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetFilenameRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetFilenameRequest = {
    // Can be \"*\" if JWT token contains the case_id.
  caseId: "case_id_example",
    // Can be \"*\" if JWT token contains the task_id.
  taskId: "task_id_example",
};

const data = await apiInstance.workflowGetFilename(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
caseId	[string]	Can be "*" if JWT token contains the case_id.	defaults to undefined
taskId	[string]	Can be "*" if JWT token contains the task_id.	defaults to undefined

Return type

Workflowv3GetFilenameResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetJobsCount

Workflowv3GetJobsCountResponse workflowGetJobsCount(workflowv3GetJobsCountRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetJobsCountRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetJobsCountRequest = {
    // Case ID - can be * for all
  caseId: "case_id_example",
  
  workflowv3GetJobsCountRequest: {
    caseId: "caseId_example",
    filter: {
      assignedToMe: true,
      assignedToMyRoles: true,
      dateCreated: new Date('1970-01-01T00:00:00.00Z'),
      dateCreatedOperator: "IGNORE",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dateDueOperator: "IGNORE",
      filterColumns: [
        {
          headerName: "headerName_example",
          operatorType: "UNDEFINED_OPERATOR_TYPE",
          values: [
            "values_example",
          ],
        },
      ],
      priority: "UNDEFINED_PRIORITY",
      priorityOperator: "IGNORE",
      reportId: "reportId_example",
      scheduledJobId: [
        "scheduledJobId_example",
      ],
      scheduledTaskId: [
        "scheduledTaskId_example",
      ],
      status: "UNDEFINED_STATUS",
      statusOperator: "IGNORE",
      tags: [
        "tags_example",
      ],
    },
  },
};

const data = await apiInstance.workflowGetJobsCount(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3GetJobsCountRequest	Workflowv3GetJobsCountRequest
caseId	[string]	Case ID - can be * for all	defaults to undefined

Return type

Workflowv3GetJobsCountResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetProductEntities

Workflowv3GetProductEntitiesResponse workflowGetProductEntities()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetProductEntitiesRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetProductEntitiesRequest = {
    // Optional starting point for the page of data. (optional)
  offset: 1,
    // Optional page size. (optional)
  limit: 1,
};

const data = await apiInstance.workflowGetProductEntities(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
offset	[number]	Optional starting point for the page of data.	(optional) defaults to undefined
limit	[number]	Optional page size.	(optional) defaults to undefined

Return type

Workflowv3GetProductEntitiesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetProductEntity

Workflowv3ProductEntity workflowGetProductEntity()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetProductEntityRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetProductEntityRequest = {
    // Unique id for the product entity
  entityId: "entity_id_example",
};

const data = await apiInstance.workflowGetProductEntity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
entityId	[string]	Unique id for the product entity	defaults to undefined

Return type

Workflowv3ProductEntity

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetReportResult

Workflowv3GetReportResultResponse workflowGetReportResult()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetReportResultRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetReportResultRequest = {
    // ID to get the case  (read-only).
  caseId: "case_id_example",
    // ID to get the task for case(read-only).
  taskId: "task_id_example",
    // Optional starting point for the page of data. (optional)
  offset: 1,
    // Optional page size. (optional)
  limit: 1,
};

const data = await apiInstance.workflowGetReportResult(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
caseId	[string]	ID to get the case (read-only).	defaults to undefined
taskId	[string]	ID to get the task for case(read-only).	defaults to undefined
offset	[number]	Optional starting point for the page of data.	(optional) defaults to undefined
limit	[number]	Optional page size.	(optional) defaults to undefined

Return type

Workflowv3GetReportResultResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetTasks

Workflowv3TaskListResponse workflowGetTasks()

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetTasksRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetTasksRequest = {
    // Mandaroty: The parent case which contains the tasks.
  caseId: "case_id_example",
    // Optional: task_id to return an array of one. (optional)
  taskId: "task_id_example",
};

const data = await apiInstance.workflowGetTasks(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
caseId	[string]	Mandaroty: The parent case which contains the tasks.	defaults to undefined
taskId	[string]	Optional: task_id to return an array of one.	(optional) defaults to undefined

Return type

Workflowv3TaskListResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowGetTasksCount

Workflowv3GetTasksCountResponse workflowGetTasksCount(workflowv3GetTasksCountRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowGetTasksCountRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowGetTasksCountRequest = {
    // Case ID - can be * for all
  caseId: "case_id_example",
  
  workflowv3GetTasksCountRequest: {
    caseId: "caseId_example",
    filter: {
      assignedToMe: true,
      assignedToMyRoles: true,
      dateCreated: new Date('1970-01-01T00:00:00.00Z'),
      dateCreatedOperator: "IGNORE",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dateDueOperator: "IGNORE",
      filterColumns: [
        {
          headerName: "headerName_example",
          operatorType: "UNDEFINED_OPERATOR_TYPE",
          values: [
            "values_example",
          ],
        },
      ],
      priority: "UNDEFINED_PRIORITY",
      priorityOperator: "IGNORE",
      reportId: "reportId_example",
      scheduledJobId: [
        "scheduledJobId_example",
      ],
      scheduledTaskId: [
        "scheduledTaskId_example",
      ],
      status: "UNDEFINED_STATUS",
      statusOperator: "IGNORE",
      tags: [
        "tags_example",
      ],
    },
  },
};

const data = await apiInstance.workflowGetTasksCount(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3GetTasksCountRequest	Workflowv3GetTasksCountRequest
caseId	[string]	Case ID - can be * for all	defaults to undefined

Return type

Workflowv3GetTasksCountResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowSearchCases

Workflowv3CaseListResponse workflowSearchCases(workflowv3SearchCasesRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowSearchCasesRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowSearchCasesRequest = {
  
  workflowv3SearchCasesRequest: {
    filter: {
      assignedToMe: true,
      assignedToMyRoles: true,
      dateCreated: new Date('1970-01-01T00:00:00.00Z'),
      dateCreatedOperator: "IGNORE",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dateDueOperator: "IGNORE",
      filterColumns: [
        {
          headerName: "headerName_example",
          operatorType: "UNDEFINED_OPERATOR_TYPE",
          values: [
            "values_example",
          ],
        },
      ],
      priority: "UNDEFINED_PRIORITY",
      priorityOperator: "IGNORE",
      reportId: "reportId_example",
      scheduledJobId: [
        "scheduledJobId_example",
      ],
      scheduledTaskId: [
        "scheduledTaskId_example",
      ],
      status: "UNDEFINED_STATUS",
      statusOperator: "IGNORE",
      tags: [
        "tags_example",
      ],
    },
    limit: 1,
    offset: 1,
    withLatest: true,
  },
};

const data = await apiInstance.workflowSearchCases(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3SearchCasesRequest	Workflowv3SearchCasesRequest

Return type

Workflowv3CaseListResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowSearchReports

Workflowv3SearchReportsResponse workflowSearchReports(workflowv3SearchCasesRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowSearchReportsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowSearchReportsRequest = {
  
  workflowv3SearchCasesRequest: {
    filter: {
      assignedToMe: true,
      assignedToMyRoles: true,
      dateCreated: new Date('1970-01-01T00:00:00.00Z'),
      dateCreatedOperator: "IGNORE",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dateDueOperator: "IGNORE",
      filterColumns: [
        {
          headerName: "headerName_example",
          operatorType: "UNDEFINED_OPERATOR_TYPE",
          values: [
            "values_example",
          ],
        },
      ],
      priority: "UNDEFINED_PRIORITY",
      priorityOperator: "IGNORE",
      reportId: "reportId_example",
      scheduledJobId: [
        "scheduledJobId_example",
      ],
      scheduledTaskId: [
        "scheduledTaskId_example",
      ],
      status: "UNDEFINED_STATUS",
      statusOperator: "IGNORE",
      tags: [
        "tags_example",
      ],
    },
    limit: 1,
    offset: 1,
    withLatest: true,
  },
};

const data = await apiInstance.workflowSearchReports(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3SearchCasesRequest	Workflowv3SearchCasesRequest

Return type

Workflowv3SearchReportsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowSearchTasks

Workflowv3TaskListResponse workflowSearchTasks(workflowv3SearchTasksRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowSearchTasksRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowSearchTasksRequest = {
    // Case ID - can be * for all
  caseId: "case_id_example",
  
  workflowv3SearchTasksRequest: {
    caseId: "caseId_example",
    filter: {
      assignedToMe: true,
      assignedToMyRoles: true,
      dateCreated: new Date('1970-01-01T00:00:00.00Z'),
      dateCreatedOperator: "IGNORE",
      dateDue: new Date('1970-01-01T00:00:00.00Z'),
      dateDueOperator: "IGNORE",
      filterColumns: [
        {
          headerName: "headerName_example",
          operatorType: "UNDEFINED_OPERATOR_TYPE",
          values: [
            "values_example",
          ],
        },
      ],
      priority: "UNDEFINED_PRIORITY",
      priorityOperator: "IGNORE",
      reportId: "reportId_example",
      scheduledJobId: [
        "scheduledJobId_example",
      ],
      scheduledTaskId: [
        "scheduledTaskId_example",
      ],
      status: "UNDEFINED_STATUS",
      statusOperator: "IGNORE",
      tags: [
        "tags_example",
      ],
    },
    limit: 1,
    offset: 1,
    sortField: "sortField_example",
    sortOrder: "UNDEFINED_ORDER_BY",
    taskId: "taskId_example",
  },
};

const data = await apiInstance.workflowSearchTasks(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3SearchTasksRequest	Workflowv3SearchTasksRequest
caseId	[string]	Case ID - can be * for all	defaults to undefined

Return type

Workflowv3TaskListResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowUpdateCases

Workflowv3UpdateCasesResponse workflowUpdateCases(workflowv3UpdateCasesRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowUpdateCasesRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowUpdateCasesRequest = {
  
  workflowv3UpdateCasesRequest: {
    cases: [
      {
        artifacts: [
          "artifacts_example",
        ],
        assignments: [
          {
            label: "label_example",
            templateId: "templateId_example",
            type: "UNDEFINED_ENTITY_TYPE",
            value: "value_example",
          },
        ],
        caseId: "caseId_example",
        comment: "comment_example",
        dateDue: new Date('1970-01-01T00:00:00.00Z'),
        description: "description_example",
        priority: "UNDEFINED_PRIORITY",
        status: "UNDEFINED_STATUS",
        title: "title_example",
      },
    ],
    updateFields: [
      "updateFields_example",
    ],
  },
};

const data = await apiInstance.workflowUpdateCases(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3UpdateCasesRequest	Workflowv3UpdateCasesRequest

Return type

Workflowv3UpdateCasesResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowUpdateProductEntity

Workflowv3UpdateProductEntityResponse workflowUpdateProductEntity(workflowv3UpdateProductEntityRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowUpdateProductEntityRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowUpdateProductEntityRequest = {
    // Unique Entity id, required for update.
  entityId: "entity_id_example",
  
  workflowv3UpdateProductEntityRequest: {
    entityId: "entityId_example",
    productEntity: {
      entity: {
        disabled: true,
        entityId: "entityId_example",
        entityLabel: "entityLabel_example",
        featureFlag: "featureFlag_example",
        preventDelete: true,
        privilegeId: "privilegeId_example",
        privilegeType: "privilegeType_example",
        productId: "productId_example",
        productLabel: "productLabel_example",
        templateOrigin: "templateOrigin_example",
        workflow: {
          auditType: "UNDEFINED_TYPE",
          configTypes: [
            "configTypes_example",
          ],
          workflowInvestigationLinks: [
            {
              display: "display_example",
              id: "id_example",
              type: "type_example",
            },
          ],
          workflowResponseTemplate: {
            display: "display_example",
            id: "id_example",
            type: "type_example",
          },
          workflowUniqueFields: [
            "workflowUniqueFields_example",
          ],
        },
      },
      headers: [
        {
          choices: [
            {
              disabled: true,
              label: "label_example",
              name: "name_example",
            },
          ],
          groupTypeId: 1,
          hideFromView: true,
          key: "key_example",
          type: "STRING",
          value: "value_example",
        },
      ],
    },
  },
};

const data = await apiInstance.workflowUpdateProductEntity(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3UpdateProductEntityRequest	Workflowv3UpdateProductEntityRequest
entityId	[string]	Unique Entity id, required for update.	defaults to undefined

Return type

Workflowv3UpdateProductEntityResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

workflowUpdateTasks

Workflowv3UpdateTasksResponse workflowUpdateTasks(workflowv3UpdateTasksRequest)

Example

import { createConfiguration, WorkflowApi } from '';
import type { WorkflowApiWorkflowUpdateTasksRequest } from '';

const configuration = createConfiguration();
const apiInstance = new WorkflowApi(configuration);

const request: WorkflowApiWorkflowUpdateTasksRequest = {
    // Update tasks belonging to common parent.
  caseId: "case_id_example",
  
  workflowv3UpdateTasksRequest: {
    caseId: "caseId_example",
    tasks: [
      {
        assignments: [
          {
            label: "label_example",
            templateId: "templateId_example",
            type: "UNDEFINED_ENTITY_TYPE",
            value: "value_example",
          },
        ],
        comment: "comment_example",
        dateDue: new Date('1970-01-01T00:00:00.00Z'),
        dependsOn: [
          "dependsOn_example",
        ],
        description: "description_example",
        investigationLinks: [
          {
            display: "display_example",
            id: "id_example",
            type: "type_example",
          },
        ],
        justification: "justification_example",
        priority: "UNDEFINED_PRIORITY",
        responseTemplate: {
          display: "display_example",
          id: "id_example",
          type: "type_example",
        },
        reviewAction: "reviewAction_example",
        status: "UNDEFINED_STATUS",
        tags: [
          "tags_example",
        ],
        taskId: "taskId_example",
        title: "title_example",
      },
    ],
    updateFields: [
      "updateFields_example",
    ],
    workflowId: "workflowId_example",
  },
};

const data = await apiInstance.workflowUpdateTasks(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
workflowv3UpdateTasksRequest	Workflowv3UpdateTasksRequest
caseId	[string]	Update tasks belonging to common parent.	defaults to undefined

Return type

Workflowv3UpdateTasksResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A successful response.	-
0	An unexpected error response.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

WorkflowApi.md

Latest commit

History

WorkflowApi.md

File metadata and controls

.WorkflowApi

workflowCreateCase

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowCreateProductEntity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowCreateTask

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowCreateWorkflowEvent

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowDeleteProductEntity

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowGetCases

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowGetCasesCount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowGetFilename

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowGetJobsCount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowGetProductEntities

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

workflowGetProductEntity

Example

Parameters