Class CaseService

Index

Methods

activityDirectSubmit activitySubmit caseInfo caseTaskCreate caseTaskGet caseTaskSubmit caseView datasetGet datasetGetViaWidget datasetRetrieve datasetRetrieveViaWidget formGet formRetrieve taskCreate taskInfo taskSubmit

Methods

`Static`activityDirectSubmit

activityDirectSubmit(
    casePath: string,
    activity: string,
    requestBody?: Record<string, any>,
): CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
Submit (create and submit) an activity based on the activity ID and filled in fields
Parameters
- casePath: string
  Path or Id of case
- activity: string
  ID of activity
- OptionalrequestBody: Record<string, any>
Returns CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
any Submit (create and submit) an activity based on the activity ID and filled in fields

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:220

`Static`activitySubmit

activitySubmit(
    caseId: string,
    activity: string,
    requestBody?: Record<string, any>,
): CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
Parameters
- caseId: string
  ID of case
- activity: string
  ID of activity
- OptionalrequestBody: Record<string, any>
Returns CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
any Submit (create and submit) an activity based on the activity ID and filled in fields

Deprecated
Submit (create and submit) an activity based on the activity ID and filled in fields

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:629

`Static`caseInfo

caseInfo(
    casePath: string,
    css?: boolean,
    rootline?: boolean,
    views?: boolean,
): CancelablePromise<
    {
        caseRedirect?: string;
        casetype: {
            cssTemplates?: CasetypeCss[];
            defaultView?: string;
            name: string;
            platformCssTemplates?: CasetypeCss[];
            platformTheme?: any;
            views?: any[];
        };
        devParentCase?: string;
        id: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reference?: string;
        reference_encodehtml?: string;
        reloadCaches?: string;
        rootline?: { id: string; reference?: string }[];
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
        userCaseLocale?: string;
    },
>
Retrieve information on a case
Parameters
- casePath: string
  Path or Id of case
- Optionalcss: boolean
  Set css
- Optionalrootline: boolean
  Set rootline
- Optionalviews: boolean
  Set views
Returns CancelablePromise<
    {
        caseRedirect?: string;
        casetype: {
            cssTemplates?: CasetypeCss[];
            defaultView?: string;
            name: string;
            platformCssTemplates?: CasetypeCss[];
            platformTheme?: any;
            views?: any[];
        };
        devParentCase?: string;
        id: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reference?: string;
        reference_encodehtml?: string;
        reloadCaches?: string;
        rootline?: { id: string; reference?: string }[];
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
        userCaseLocale?: string;
    },
>
any Retrieve information on a case

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:42

`Static`caseTaskCreate

caseTaskCreate(
    caseId: string,
    activity: string,
    format?: "simple" | "full",
    requestBody?:
        | {
            activity: string;
            autoProgress?: boolean;
            skipCheckRights?: boolean;
            type: "optional";
        }
        | {
            activityTag: string;
            autoProgress?: boolean;
            skipCheckRights?: boolean;
            type: "optionalByTag";
        }
        | {
            autoProgress?: boolean;
            skipCheckRights?: boolean;
            task?: number;
            type: "task"
            | "mandatory"
            | "required"
            | "optionalTask";
        },
): CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
Parameters
- caseId: string
  ID of case
- activity: string
  ID of activity
- format: "simple" | "full" = 'full'
  Format of the result
- OptionalrequestBody:
      | {
          activity: string;
          autoProgress?: boolean;
          skipCheckRights?: boolean;
          type: "optional";
      }
      | {
          activityTag: string;
          autoProgress?: boolean;
          skipCheckRights?: boolean;
          type: "optionalByTag";
      }
      | {
          autoProgress?: boolean;
          skipCheckRights?: boolean;
          task?: number;
          type: "task"
          | "mandatory"
          | "required"
          | "optionalTask";
      }
Returns CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
any Create a new optional task based on an activity ID

Deprecated
Create a new optional task based on an activity ID

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:670

`Static`caseTaskGet

caseTaskGet(
    caseId: string,
    task: number,
    format?: "simple" | "full",
): CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
Parameters
- caseId: string
  ID of case
- task: number
  ID of task
- format: "simple" | "full" = 'full'
  Format of the result
Returns CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
any Retrieve an existing task based on the task ID

Deprecated
Retrieve an existing task based on the task ID

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:735

`Static`caseTaskSubmit

caseTaskSubmit(
    caseId: string,
    task: number,
    requestBody?:
        | {
            activity: string;
            autoProgress?: boolean;
            fields?: MapStringObject;
            returnResult?: boolean;
            skipCheckRights?: boolean;
            type?: "optional";
        }
        | {
            autoProgress?: boolean;
            fields?: {
                devref?: string;
                externalReference?: string;
                id?: string;
                name?: string;
                value?: any;
            }[];
            returnResult?: boolean;
            skipCheckRights?: boolean;
            task?: number;
            type?: "task-array";
        }
        | {
            autoProgress?: boolean;
            fields?: MapStringObject;
            returnResult?: boolean;
            skipCheckRights?: boolean;
            task?: number;
            type?: "task-json";
        },
): CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
Parameters
- caseId: string
  ID of case
- task: number
  ID of task
- OptionalrequestBody:
      | {
          activity: string;
          autoProgress?: boolean;
          fields?: MapStringObject;
          returnResult?: boolean;
          skipCheckRights?: boolean;
          type?: "optional";
      }
      | {
          autoProgress?: boolean;
          fields?: {
              devref?: string;
              externalReference?: string;
              id?: string;
              name?: string;
              value?: any;
          }[];
          returnResult?: boolean;
          skipCheckRights?: boolean;
          task?: number;
          type?: "task-array";
      }
      | {
          autoProgress?: boolean;
          fields?: MapStringObject;
          returnResult?: boolean;
          skipCheckRights?: boolean;
          task?: number;
          type?: "task-json";
      }
Returns CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
any Submit an existing task based on the task ID and filled in fields

Deprecated
Submit an existing task based on the task ID and filled in fields

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:782

`Static`caseView

caseView(
    caseId: string,
    css?: boolean,
    rootline?: boolean,
    views?: boolean,
): CancelablePromise<
    {
        caseRedirect?: string;
        casetype: {
            cssTemplates?: CasetypeCss[];
            defaultView?: string;
            name: string;
            platformCssTemplates?: CasetypeCss[];
            platformTheme?: any;
            views?: any[];
        };
        devParentCase?: string;
        id: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reference?: string;
        reference_encodehtml?: string;
        reloadCaches?: string;
        rootline?: { id: string; reference?: string }[];
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
        userCaseLocale?: string;
    },
>
Parameters
- caseId: string
  ID of case
- Optionalcss: boolean
  Set css
- Optionalrootline: boolean
  Set rootline
- Optionalviews: boolean
  Set views
Returns CancelablePromise<
    {
        caseRedirect?: string;
        casetype: {
            cssTemplates?: CasetypeCss[];
            defaultView?: string;
            name: string;
            platformCssTemplates?: CasetypeCss[];
            platformTheme?: any;
            views?: any[];
        };
        devParentCase?: string;
        id: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reference?: string;
        reference_encodehtml?: string;
        reloadCaches?: string;
        rootline?: { id: string; reference?: string }[];
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
        userCaseLocale?: string;
    },
>
any Retrieve information on a case

Deprecated
Retrieve information on a case

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:447

`Static`datasetGet

datasetGet(
    caseId: string,
    dataset: string,
    format?: "simple" | "full",
    requestBody?: {
        additionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        allowHtmlAlways?: boolean;
        calculateFullCount?: boolean;
        columns?: string[];
        dataset: string;
        doAnalysis?: boolean;
        forceCount?: boolean;
        identifier?: ColumnIdentifier;
        limit?: number;
        search?: SortConfigSearchCondition
        | SortConfigSearchList;
        skip?: number;
        sort?: SortConfigSort[];
        unAggregatedAdditionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        unAggregatedSearch?: SortConfigSearchCondition
        | SortConfigSearchList;
    },
): CancelablePromise<DatasetResult>
Parameters
- caseId: string
  ID of case
- dataset: string
  ID of dataset
- format: "simple" | "full" = 'simple'
  Format of the result
- OptionalrequestBody: {
      additionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      allowHtmlAlways?: boolean;
      calculateFullCount?: boolean;
      columns?: string[];
      dataset: string;
      doAnalysis?: boolean;
      forceCount?: boolean;
      identifier?: ColumnIdentifier;
      limit?: number;
      search?: SortConfigSearchCondition
      | SortConfigSearchList;
      skip?: number;
      sort?: SortConfigSort[];
      unAggregatedAdditionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      unAggregatedSearch?: SortConfigSearchCondition
      | SortConfigSearchList;
  }
Returns CancelablePromise<DatasetResult>
DatasetResult Retrieve the contents of a dataset. Rights are checked via dataset rights, unless called from a Scripted System Service.

Deprecated
Retrieve the contents of a dataset. Rights are checked via dataset rights, unless called from a Scripted System Service.

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:509

`Static`datasetGetViaWidget

datasetGetViaWidget(
    caseId: string,
    dataset: string,
    widget: string,
    format?: "simple" | "full",
    requestBody?: {
        additionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        allowHtmlAlways?: boolean;
        calculateFullCount?: boolean;
        columns?: string[];
        dataset: string;
        doAnalysis?: boolean;
        forceCount?: boolean;
        identifier?: ColumnIdentifier;
        limit?: number;
        search?: SortConfigSearchCondition
        | SortConfigSearchList;
        skip?: number;
        sort?: SortConfigSort[];
        unAggregatedAdditionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        unAggregatedSearch?: SortConfigSearchCondition
        | SortConfigSearchList;
        widget: string;
        widgetCaseid?: string;
    },
): CancelablePromise<DatasetResult>
Parameters
- caseId: string
  ID of case
- dataset: string
  ID of dataset
- widget: string
  ID of widget
- format: "simple" | "full" = 'full'
  Format of the result
- OptionalrequestBody: {
      additionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      allowHtmlAlways?: boolean;
      calculateFullCount?: boolean;
      columns?: string[];
      dataset: string;
      doAnalysis?: boolean;
      forceCount?: boolean;
      identifier?: ColumnIdentifier;
      limit?: number;
      search?: SortConfigSearchCondition
      | SortConfigSearchList;
      skip?: number;
      sort?: SortConfigSort[];
      unAggregatedAdditionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      unAggregatedSearch?: SortConfigSearchCondition
      | SortConfigSearchList;
      widget: string;
      widgetCaseid?: string;
  }
Returns CancelablePromise<DatasetResult>
DatasetResult Retrieve the contents of a dataset. Rights are checked via widget rights, unless called from a Scripted System Service.

Deprecated
Retrieve the contents of a dataset. Rights are checked via widget rights, unless called from a Scripted System Service.

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:581

`Static`datasetRetrieve

datasetRetrieve(
    casePath: string,
    dataset: string,
    format?: "simple" | "full",
    requestBody?: {
        additionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        allowHtmlAlways?: boolean;
        calculateFullCount?: boolean;
        columns?: string[];
        dataset: string;
        doAnalysis?: boolean;
        forceCount?: boolean;
        identifier?: ColumnIdentifier;
        limit?: number;
        search?: SortConfigSearchCondition
        | SortConfigSearchList;
        skip?: number;
        sort?: SortConfigSort[];
        unAggregatedAdditionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        unAggregatedSearch?: SortConfigSearchCondition
        | SortConfigSearchList;
    },
): CancelablePromise<DatasetResult>
Retrieve the contents of a dataset. Rights are checked via dataset rights, unless called from a Scripted System Service.
Parameters
- casePath: string
  Path or Id of case
- dataset: string
  ID of dataset
- format: "simple" | "full" = 'simple'
  Format of the result
- OptionalrequestBody: {
      additionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      allowHtmlAlways?: boolean;
      calculateFullCount?: boolean;
      columns?: string[];
      dataset: string;
      doAnalysis?: boolean;
      forceCount?: boolean;
      identifier?: ColumnIdentifier;
      limit?: number;
      search?: SortConfigSearchCondition
      | SortConfigSearchList;
      skip?: number;
      sort?: SortConfigSort[];
      unAggregatedAdditionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      unAggregatedSearch?: SortConfigSearchCondition
      | SortConfigSearchList;
  }
Returns CancelablePromise<DatasetResult>
DatasetResult Retrieve the contents of a dataset. Rights are checked via dataset rights, unless called from a Scripted System Service.

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:103

`Static`datasetRetrieveViaWidget

datasetRetrieveViaWidget(
    casePath: string,
    dataset: string,
    widget: string,
    format?: "simple" | "full",
    requestBody?: {
        additionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        allowHtmlAlways?: boolean;
        calculateFullCount?: boolean;
        columns?: string[];
        dataset: string;
        doAnalysis?: boolean;
        forceCount?: boolean;
        identifier?: ColumnIdentifier;
        limit?: number;
        search?: SortConfigSearchCondition
        | SortConfigSearchList;
        skip?: number;
        sort?: SortConfigSort[];
        unAggregatedAdditionalColumns?: (
            | AdditionalAggregateColumn
            | AdditionalDataHistoryColumn
            | AdditionalDerivedColumn
            | AdditionalExternalColumn
            | AdditionalGroupbyColumn
            | AdditionalMetaColumn
            | AdditionalTemplateColumn
        )[];
        unAggregatedSearch?: SortConfigSearchCondition
        | SortConfigSearchList;
        widget: string;
        widgetCaseid?: string;
    },
): CancelablePromise<DatasetResult>
Retrieve the contents of a dataset. Rights are checked via widget rights, unless called from a Scripted System Service.
Parameters
- casePath: string
  Path or Id of case
- dataset: string
  ID of dataset
- widget: string
  ID of widget
- format: "simple" | "full" = 'full'
  Format of the result
- OptionalrequestBody: {
      additionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      allowHtmlAlways?: boolean;
      calculateFullCount?: boolean;
      columns?: string[];
      dataset: string;
      doAnalysis?: boolean;
      forceCount?: boolean;
      identifier?: ColumnIdentifier;
      limit?: number;
      search?: SortConfigSearchCondition
      | SortConfigSearchList;
      skip?: number;
      sort?: SortConfigSort[];
      unAggregatedAdditionalColumns?: (
          | AdditionalAggregateColumn
          | AdditionalDataHistoryColumn
          | AdditionalDerivedColumn
          | AdditionalExternalColumn
          | AdditionalGroupbyColumn
          | AdditionalMetaColumn
          | AdditionalTemplateColumn
      )[];
      unAggregatedSearch?: SortConfigSearchCondition
      | SortConfigSearchList;
      widget: string;
      widgetCaseid?: string;
  }
Returns CancelablePromise<DatasetResult>
DatasetResult Retrieve the contents of a dataset. Rights are checked via widget rights, unless called from a Scripted System Service.

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:173

`Static`formGet

formGet(
    caseId: string,
    formId: string,
    format?: "simple" | "full" | "extended",
): CancelablePromise<any>
Parameters
- caseId: string
  ID of case
- formId: string
  ID of form
- format: "simple" | "full" | "extended" = 'simple'
  Format of the result
Returns CancelablePromise<any>
any Retrieve the contents of a form. Rights are checked via form rights, unless called from a Scripted System Service.

Deprecated
Retrieve the contents of a form. Rights are checked via form rights, unless called from a Scripted System Service.

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:553

`Static`formRetrieve

formRetrieve(
    casePath: string,
    formId: string,
    format?: "simple" | "full" | "extended",
): CancelablePromise<any>
Retrieve the contents of a form. Rights are checked via form rights, unless called from a Scripted System Service.
Parameters
- casePath: string
  Path or Id of case
- formId: string
  ID of form
- format: "simple" | "full" | "extended" = 'simple'
  Format of the result
Returns CancelablePromise<any>
any Retrieve the contents of a form. Rights are checked via form rights, unless called from a Scripted System Service.

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:146

`Static`taskCreate

taskCreate(
    casePath: string,
    activity: string,
    format?: "simple" | "full",
    requestBody?:
        | {
            activity: string;
            autoProgress?: boolean;
            skipCheckRights?: boolean;
            type: "optional";
        }
        | {
            activityTag: string;
            autoProgress?: boolean;
            skipCheckRights?: boolean;
            type: "optionalByTag";
        }
        | {
            autoProgress?: boolean;
            skipCheckRights?: boolean;
            task?: number;
            type: "task"
            | "mandatory"
            | "required"
            | "optionalTask";
        },
): CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
Create a new optional task based on an activity ID
Parameters
- casePath: string
  Path or Id of case
- activity: string
  ID of activity
- format: "simple" | "full" = 'full'
  Format of the result
- OptionalrequestBody:
      | {
          activity: string;
          autoProgress?: boolean;
          skipCheckRights?: boolean;
          type: "optional";
      }
      | {
          activityTag: string;
          autoProgress?: boolean;
          skipCheckRights?: boolean;
          type: "optionalByTag";
      }
      | {
          autoProgress?: boolean;
          skipCheckRights?: boolean;
          task?: number;
          type: "task"
          | "mandatory"
          | "required"
          | "optionalTask";
      }
Returns CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
any Create a new optional task based on an activity ID

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:260

`Static`taskInfo

taskInfo(
    casePath: string,
    task: number,
    format?: "simple" | "full",
): CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
Retrieve an existing task based on the task ID
Parameters
- casePath: string
  Path or Id of case
- task: number
  ID of task
- format: "simple" | "full" = 'full'
  Format of the result
Returns CancelablePromise<
    {
        activity?: Activity;
        dateSuggested?: string;
        form?: any;
        formCondition?: | FormFieldSimpleCondition
        | FormFieldConditionList
        | FormFieldNotCondition;
        name?: string;
        parentCase?: string;
        startActivity?: Activity;
        suggested?: { formField?: string; value?: FilledInValue[] }[];
        suggestedBy?: {
            caseId?: string;
            caseReference?: string;
            casetypeCaseId?: string;
            casetypeDevRef?: string;
            casetypeName?: string;
            hasAnyRight?: boolean;
        };
        task?: number;
    },
>
any Retrieve an existing task based on the task ID

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:324

`Static`taskSubmit

taskSubmit(
    casePath: string,
    task: number,
    requestBody?:
        | {
            activity: string;
            autoProgress?: boolean;
            fields?: MapStringObject;
            returnResult?: boolean;
            skipCheckRights?: boolean;
            type?: "optional";
        }
        | {
            autoProgress?: boolean;
            fields?: {
                devref?: string;
                externalReference?: string;
                id?: string;
                name?: string;
                value?: any;
            }[];
            returnResult?: boolean;
            skipCheckRights?: boolean;
            task?: number;
            type?: "task-array";
        }
        | {
            autoProgress?: boolean;
            fields?: MapStringObject;
            returnResult?: boolean;
            skipCheckRights?: boolean;
            task?: number;
            type?: "task-json";
        },
): CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
Submit an existing task based on the task ID and filled in fields
Parameters
- casePath: string
  Path or Id of case
- task: number
  ID of task
- OptionalrequestBody:
      | {
          activity: string;
          autoProgress?: boolean;
          fields?: MapStringObject;
          returnResult?: boolean;
          skipCheckRights?: boolean;
          type?: "optional";
      }
      | {
          autoProgress?: boolean;
          fields?: {
              devref?: string;
              externalReference?: string;
              id?: string;
              name?: string;
              value?: any;
          }[];
          returnResult?: boolean;
          skipCheckRights?: boolean;
          task?: number;
          type?: "task-array";
      }
      | {
          autoProgress?: boolean;
          fields?: MapStringObject;
          returnResult?: boolean;
          skipCheckRights?: boolean;
          task?: number;
          type?: "task-json";
      }
Returns CancelablePromise<
    {
        createdCase?: string;
        jumpToCase?: boolean;
        jumpToCase_case?: string;
        jumpToCase_view?: string;
        redirectToURL?: string;
        redirectToURL_data?: string;
        redirectToURL_encoding?: string;
        redirectToURL_method?: string;
        reloadCaches?: string;
        returnResult?: MapStringObject;
        status?: string;
        submitMessageBody?: string;
        submitMessageButtonText?: string;
        submitMessageStyle?: string;
    },
>
any Submit an existing task based on the task ID and filled in fields

Throws
ApiError
- Defined in grexx-api/src/generated/services/CaseService.ts:370

Class CaseService

Index

Methods

Methods

StaticactivityDirectSubmit

Parameters

Throws

StaticactivitySubmit

Parameters

Deprecated

Throws

StaticcaseInfo

Parameters

Throws

StaticcaseTaskCreate

Parameters

Deprecated

Throws

StaticcaseTaskGet

Parameters

Deprecated

Throws

StaticcaseTaskSubmit

Parameters

Deprecated

Throws

StaticcaseView

Parameters

Deprecated

Throws

StaticdatasetGet

Parameters

Returns CancelablePromise<DatasetResult>

Deprecated

Throws

StaticdatasetGetViaWidget

Parameters

Returns CancelablePromise<DatasetResult>

Deprecated

Throws

StaticdatasetRetrieve

Parameters

Returns CancelablePromise<DatasetResult>

Throws

StaticdatasetRetrieveViaWidget

Parameters

Returns CancelablePromise<DatasetResult>

Throws

StaticformGet

Parameters

Returns CancelablePromise<any>

Deprecated

Throws

StaticformRetrieve

Parameters

Returns CancelablePromise<any>

Throws

StatictaskCreate

Parameters

Throws

StatictaskInfo

Parameters

Throws

StatictaskSubmit

Parameters

Throws

Settings

On This Page

`Static`activityDirectSubmit

`Static`activitySubmit

`Static`caseInfo

`Static`caseTaskCreate

`Static`caseTaskGet

`Static`caseTaskSubmit

`Static`caseView

`Static`datasetGet

`Static`datasetGetViaWidget

`Static`datasetRetrieve

`Static`datasetRetrieveViaWidget

`Static`formGet

`Static`formRetrieve

`Static`taskCreate

`Static`taskInfo

`Static`taskSubmit