/utility

Internal utility endpoint.

Table of Contents #

GET /utility/getJs #

Internal API request.

Request javascript files from the api to create your own widgets. There are several different files that can be requested Silobreaker-1-nojquery.js, Silobreaker-1.js, etc.

Request

GET /utility/getJs/{jsfileName}
GET /utility/getJs/Silobreaker-1-nojquery.js

GET /utility/getImage #

Internal API request.

This Api request is only used by the mobile app to determine what type of image to use. It only supports the type png, if any other type is used this request will throw an ApiException.

Request

GET /utility/getImage
GET /utility/getImage/?type=png&category=SBMobileImages&desc=ios_gradient.png

Parameters

type : Only png type is supported.

category : Needs to match the configured image section defined in the api configs.

desc : The image file name that is requested.

GET /utility/queryBeautifier #

Internal API request.

This Api request is only used internally.

Request

GET /utility/queryBeautifier
GET /utility/queryBeautifier?q=itemref:11_240886&type=json

Parameters

q : The query to beautify.

Response

Example:

{
   OriginalQueryString: "itemref:11_240886",
   DescriptiveName: "Barack Obama",
   LastUpdated: "0001-01-01T00:00:00"
}

Documentation generated by mdoc.