Get All Premise Trees
get
/api/utilitiesAdmin/{version}/premiseTree
Gets a list of Premise Tree records.
Request
Path Parameters
-
version(required): string
API version. Example: v1
Query Parameters
-
expand: string
This query parameter can be specified to retrieve an expanded version of a particular subresource. Example: ?expand=state where state is a sub resource
-
fields: string
This query parameter can be specified as comma-separated list of fields, and it returns only the specified fields for the resource. Example: ?fields=description,icon
-
limit: number
By specifying this query parameter, the number of items returned will be limited to this number. Example: ?limit=10
-
offset: number
By specifying this query parameter, a subset of records starting with this offset value will be retrieved. Example: ?offset=2
-
orderBy: string
This query parameter determines the sort order of results by a field. Example: description:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expression. The value of this query parameter is an expression(Format: ?q=expression). Supported comparison operators are: '=' , '!='. Example1: ?q=description=Electric , Example2: ?q=description!=Electric
-
totalResults: boolean
This query parameter can be specified, to return the total number of items available. Example: ?totalResults=true
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Nested Schema : premiseTreeItems
Type:
Show Source
object
-
count: number
The number of records returned in the current range.
-
hasMore: boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server.
-
items: array
items
-
limit: number
The actual paging size used by the server.
-
offset: number
The offset value used in the current page.
-
totalResults: number
The estimated total record count.
Nested Schema : premiseTree
Type:
Show Source
object
-
id(required): string
Id of the Premise Tree administration record.
-
name(required): string
Name of configuration property.
-
value(required): string
Value set for the configuration property.
400 Response
An error is encountered due to an invalid request
Root Schema : Error
Type:
Show Source
object
-
code: string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
500 Response
An internal server error is encountered, due to an unknown reason
Root Schema : Error
Type:
Show Source
object
-
code: string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension