SEservicechannel
CheckLists

Get checklists with asset tasks

Retrieves checklists of the Asset Task type along with their parameters and task details. Such checklists contain asset-related tasks that a technician is prompted to complete when working on a service request. <br />You can filter checklists by:  • Trade. Specify either tradeid or tradeName.  • Category. Enter either categoryid or categoryName.  • Location. Provide either locationId or storeId if the feature that allows creating checklists for specific locations is enabled for a subscriber.  • Checklist. Pass either checklistid or checkListName to get a specific checklist, and ignore other parameters. <br />Providers should pass subscriberId to retrieve checklists created by the desired subscriber. <br />Navigate to ServiceChannel University to find out how subscribers can configure checklists.

get/checklists/taskslist

Request

Query parameters

tradeidinteger

Trade ID. To get a list of trades with their IDs, send the GET /odata/trades request.

checklistidinteger

Checklist ID.

categoryidinteger

Category ID. Subscribers can retrieve category IDs using the GET /categories method.

subscriberIdinteger

Unique ID of the subscriber who configured checklists. Should be passed by providers.

tradeNamestring

Trade name. A trade is an area of work for which a service is performed, such as Lighting, Refrigeration, or Plumbing.

checkListNamestring

Checklist name.

categoryNamestring

Category name. A category is the overall classification of a work order, such as Maintenance, Repair, or CAPEX.

locationIdinteger

Unique ID of a subscriber’s location. This parameter is ignored if the feature that allows creating checklists for specific locations is disabled for a subscriber.

storeIdstring

Non-unique ID of a subscriber’s location that may appear as a store number. This parameter is ignored if the feature that allows creating checklists for specific locations is disabled for a subscriber.

providerIdinteger

The provider identifier. Required for sub-contractor request. [Required Special permissions]

Response

The requested asset task checklists are in the response.

Changes

No recorded changes to this operation across all 1 revision of this API.