sfgboxapi

<back to all web services

SystemEntitiesLookup

Requires Authentication
The following routes are available for this service:
GET/system_entities
"use strict";
export class SystemEntitiesLookup {
    /** @param {{entity?:string,longDescription?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    entity;
    /** @type {string} */
    longDescription;
}

JavaScript SystemEntitiesLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /system_entities HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"entity":"String","longDescription":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]