Search service request by filtering metadata

Description

Retrieve a list of service requests filtered by metadata.

Notes:
1) Metadata structure should be defined for the service
2) Matching will ignore cases however where applicable accents must be specified in "SearchValue"

Package Details

Interface

IServiceRequestManager

Syntax

Task<ServiceRequestCollectionDTO> SearchServiceRequest(ServiceRequestSearchDTO serviceRequestSearchDTO)

Returns

Task<ServiceRequestCollectionDTO>

API Endpoint

[POST] /api/servicerequests/search

Parameters	Type	Description
serviceRequestSearchDTO	ServiceRequestSearchDTO	Object used to filter service request metadata

Detail

The parameter, serviceRequestSearchDTO, consists of the following properties

Properties	Type	Description
Page	integer	The page number to be retrieved
PageSize	integer	Number of entries on a page
UserId	integer	User who has created the service request
ServiceId	integer	The service where the service request belongs
SearchValue	string	A string that will be used to list service request by matching metadata
SearchOption	string	A string that represents the KeyName in metadata structure used to determine which structure column will be filtered.

Note:

SearchValue can be partial and should be minimum two characters in length after trimming.
SearchOption determines the column structure to use for filtering metadata (i.e for Service 60, we want to filter by "project name" or "nom du projet"). It can be spedified in English or French.

{
  "UserId": 0,
  "ServiceId": 11,
  "OrganizationId": 0,
  "ExcludeMetadata": false,
  "Page": 1,
  "PageSize": 25,
  "Filter": "PlaceOfSupply='ON'",
  "Version": 1
}