Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space MOBUD and version 3

Status
colourYellow
title3.30.0

The Site History query API returns a collection of work order objects based on the filter criteria passed in on the GET request. The Site History query API will provide information about work performed at a specific site for a given customer account. 

Note

The result set will be filtered based on the permissions of the user making the request.

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel4

Related pages:

Resource URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

GET /seiapi/v3/query/Account/${AccountID}/Location/${LocationID}/History?filters=${filterOptions}&q={queryOtions}&sort=${sortOptions}&limit=${limit}

Include Page
_URI Ext Default Query Parameters
_URI Ext Default Query Parameters

Filters

The ${filterOptions} parameter supports the following REST Object Definitions Work Order Activity Related Objects Work Order Object fields:

  • ActualStartDate
  • ActualEndDate
  • DispatchStatus
  • DispatchUTC
  • OrderNum
  • OrderType
  • OrderStatus
  • PlannedEndDate
  • PlannedStateDate
  • Priority
  • UserName

Q

The ${queryOptions} parameter supports the following REST Object Definitions Work Order Activity Related Objects Work Order Object fields:

  • ActualStartDate
  • ActualEndDate
  • DispatchStatus
  • DispatchUTC
  • OrderNum
  • OrderType
  • OrderStatus
  • PlannedEndDate
  • PlannedStateDate
  • Priority
  • UserName

Sort

The ${sortOptions} parameter supports the following REST Object Definitions Work Order Activity Related Objects Work Order Object fields:

  • ActualStartDate
  • ActualEndDate
  • DispatchStatus
  • DispatchUTC
  • OrderNum
  • OrderType
  • OrderStatus
  • PlannedEndDate
  • PlannedStateDate
  • Priority
  • UserName

Include Page
_Default HTTP Headers
_Default HTTP Headers

HTTP Response Body

The response body contains a collection of Work Order Objects that match the query parameters. 

Include Page
Query Response Object
Query Response Object