HistoryFinder
Extends:
This class allow make get request to planner resource into Opengate North API.
Constructor Summary
| Public Constructor | ||
| public |
constructor(ogapi: InternalOpenGateAPI) Constructor |
|
Method Summary
| Public Methods | ||
| public |
findByOrganization(organization: *): Promise Download a complete list of scheduler history for the organization. |
|
| public |
findByOrganizationAndSchedulerId(organization: *, schedulerId: *): Promise Download a complete list of scheduler history for the organization and type selected. |
|
| public |
findByOrganizationAndType(organization: *, type: *): Promise Download a complete list of scheduler history for the organization and type selected. |
|
| public |
withLimit(limit: *): this Marks results limit |
|
| public |
withSchedulerId(schedulerId: *): this Set parameter schedulerIds |
|
| public |
withSchedulerType(schedulerType: *): this Set parameter schedulerIds |
|
Public Constructors
public constructor(ogapi: InternalOpenGateAPI) source
Constructor
Override:
GenericFinder#constructorParams:
| Name | Type | Attribute | Description |
| ogapi | InternalOpenGateAPI | Reference to the API object. |
Public Methods
public findByOrganization(organization: *): Promise source
Download a complete list of scheduler history for the organization. This execute a GET http method
Params:
| Name | Type | Attribute | Description |
| organization | * |
public findByOrganizationAndSchedulerId(organization: *, schedulerId: *): Promise source
Download a complete list of scheduler history for the organization and type selected. This execute a GET http method
Params:
| Name | Type | Attribute | Description |
| organization | * | ||
| schedulerId | * |
public findByOrganizationAndType(organization: *, type: *): Promise source
Download a complete list of scheduler history for the organization and type selected. This execute a GET http method
Params:
| Name | Type | Attribute | Description |
| organization | * | ||
| type | * |
public withLimit(limit: *): this source
Marks results limit
Params:
| Name | Type | Attribute | Description |
| limit | * |
Return:
| this |
public withSchedulerId(schedulerId: *): this source
Set parameter schedulerIds
Params:
| Name | Type | Attribute | Description |
| schedulerId | * |
Return:
| this |
public withSchedulerType(schedulerType: *): this source
Set parameter schedulerIds
Params:
| Name | Type | Attribute | Description |
| schedulerType | * |
Return:
| this |