PublicCaseResourceService | @netgrif/components-core

Hierarchy

CaseResourceService
- PublicCaseResourceService

Index

Constructors

constructor

Properties

Accessors

SERVER_URL

Methods

Constructors

constructor

new PublicCaseResourceService(provider: ResourceProvider, configService: ConfigurationService): PublicCaseResourceService

Overrides CaseResourceService.constructor
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/public/public-case-resource.service.ts:15
Parameters
- provider: ResourceProvider
- configService: ConfigurationService
Returns PublicCaseResourceService

Properties

Protected _configService

_configService: ConfigurationService

Protected _resourceProvider

_resourceProvider: ResourceProvider

Accessors

Protected SERVER_URL

get SERVER_URL(): string

Inherited from CaseResourceService.SERVER_URL
- Defined in projects/netgrif-components-core/src/lib/resources/abstract-endpoint/abstract-resource.service.ts:28
Returns string

Methods

Protected changeType

changeType<T>(r: any, propertiesParams: string): T

Inherited from CaseResourceService.changeType
- Defined in projects/netgrif-components-core/src/lib/resources/abstract-endpoint/abstract-resource.service.ts:82
Extracts data from the response r into an object with better usability.

Type Parameters
- T
Parameters
- r: any
  
  response object
- propertiesParams: string
  
  plural form of the resource name, that is used to extract the data. Eg. "cases".
Returns T

count

count(filter: Filter): Observable<Count>

Inherited from CaseResourceService.count
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:33
Get count of the cases POST {{baseUrl}}/api/workflow/case/count

Parameters
- filter: Filter
Returns Observable<Count>

createCase

createCase(body: object): Observable<EventOutcomeMessageResource>

Overrides CaseResourceService.createCase
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/public/public-case-resource.service.ts:34
Create new case POST {{baseUrl}}/api/workflow/case

Parameters
- body: object
Returns Observable<EventOutcomeMessageResource>

deleteCase

deleteCase(caseID: string, deleteSubtree?: boolean): Observable<EventOutcomeMessageResource>

Inherited from CaseResourceService.deleteCase
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:72
Delete case DELETE {{baseUrl}}/api/workflow/case/:id

Parameters
- caseID: string
- deleteSubtree: boolean = false
Returns Observable<EventOutcomeMessageResource>

getAllCase

getAllCase(): Observable<Case[]>

Inherited from CaseResourceService.getAllCase
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:46
Get all cases of the system GET {{baseUrl}}/api/workflow/all

Returns Observable<Case[]>

getAllCaseUser

getAllCaseUser(userId: string, body: object): Observable<Case[]>

Inherited from CaseResourceService.getAllCaseUser
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:106
Get all cases by user that created them POST {{baseUrl}}/api/workflow/case/author/:id

Parameters
- userId: string
- body: object
Returns Observable<Case[]>

getCaseData

getCaseData(caseID: string): Observable<EventOutcomeMessageResource>

- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/public/public-case-resource.service.ts:24
Get all case data GET {{baseUrl}}/api/public/case/:id/data

Parameters
- caseID: string
Returns Observable<EventOutcomeMessageResource>

getCaseFile

getCaseFile(caseID: string, params: HttpParams): Observable<FileResource>

Inherited from CaseResourceService.getCaseFile
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:85
Download case file field value GET {{baseUrl}}/api/workflow/case/:id/file/:field

Parameters
- caseID: string
- params: HttpParams
Returns Observable<FileResource>

getCases

getCases(body: CaseGetRequestBody, params?: Params): Observable<Page<Case>>

Inherited from CaseResourceService.getCases
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:131
Generic case search with object encoded search query. Similar to [getCasesQueryDSL]{@link CaseResourceService#getCasesQueryDSL} POST {{baseUrl}}/api/workflow/case/search_mongo

Parameters
- body: CaseGetRequestBody
  
  object defining the search query
- Optional params: Params
  
  request parameters, that can be used for sorting of results.
Returns Observable<Page<Case>>

getCasesQueryDSL

getCasesQueryDSL(body: object): Observable<Page<Case>>

Inherited from CaseResourceService.getCasesQueryDSL
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:118
Generic case search with QueryDSL predicate POST {{baseUrl}}/api/workflow/case/search2

Parameters
- body: object
Returns Observable<Page<Case>>

getOneCase

getOneCase(caseId: string): Observable<Case>

Inherited from CaseResourceService.getOneCase
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:141
Search one case by it's id. GET {{baseUrl}}/api/workflow/case/:id

Parameters
- caseId: string
Returns Observable<Case>

getOptionsEnumeration

getOptionsEnumeration(caseId: string, fieldId: string): Observable<Case>

Inherited from CaseResourceService.getOptionsEnumeration
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:151
Get options for enumeration or multiple-choice data field GET {{baseUrl}}/api/workflow/case/:caseId/field/:fieldId

Parameters
- caseId: string
- fieldId: string
Returns Observable<Case>

Protected getResourceAddress

getResourceAddress(name: string): string

Inherited from CaseResourceService.getResourceAddress
- Defined in projects/netgrif-components-core/src/lib/resources/abstract-endpoint/abstract-resource.service.ts:36
Get URL form nae.json - resources

Parameters
- name: string
  
  ID property
Returns string

Protected getResourcePage

getResourcePage<T>(r: any, propertiesParams: string): Page<T>

Inherited from CaseResourceService.getResourcePage
- Defined in projects/netgrif-components-core/src/lib/resources/abstract-endpoint/abstract-resource.service.ts:60
Parses a response r into a Page instance

Type Parameters
- T
Parameters
- r: any
  
  response object
- propertiesParams: string
  
  plural form of the resource name, that is used to extract the data. Eg. "cases".
Returns Page<T>

searchCases

searchCases(filter: Filter, params?: Params): Observable<Page<Case>>

Inherited from CaseResourceService.searchCases
- Defined in projects/netgrif-components-core/src/lib/resources/engine-endpoint/case-resource.service.ts:57
Generic case search POST {{baseUrl}}/api/workflow/case/search

Parameters
- filter: Filter
  
  filter used to search cases. Must be of type CASE.
- Optional params: Params
  
  request parameters, that can be used for sorting of results.
Returns Observable<Page<Case>>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

provider: ResourceProvider

configService: ConfigurationService

Returns PublicCaseResourceService

Properties

Protected _configService

Protected _resourceProvider

Accessors

Protected SERVER_URL

Returns string

Methods

Protected changeType

Type Parameters

T

Parameters

r: any

propertiesParams: string

Returns T

count

Parameters

filter: Filter

Returns Observable<Count>

createCase

Parameters

body: object

Returns Observable<EventOutcomeMessageResource>

deleteCase

Parameters

caseID: string

deleteSubtree: boolean = false

Returns Observable<EventOutcomeMessageResource>

getAllCase

Returns Observable<Case[]>

getAllCaseUser

Parameters

userId: string

body: object

Returns Observable<Case[]>

getCaseData

Parameters

caseID: string

Returns Observable<EventOutcomeMessageResource>

getCaseFile

Parameters

caseID: string

params: HttpParams

Returns Observable<FileResource>

getCases

Parameters

body: CaseGetRequestBody

Optional params: Params

Returns Observable<Page<Case>>

getCasesQueryDSL

Parameters

body: object

Returns Observable<Page<Case>>

getOneCase

Parameters

caseId: string

Returns Observable<Case>

getOptionsEnumeration

Parameters

caseId: string

fieldId: string

Returns Observable<Case>

Protected getResourceAddress

Parameters

name: string

Returns string

Protected getResourcePage

Type Parameters

T