sfgboxapi

<back to all web services

SystemEntitiesAdd

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

JavaScript SystemEntitiesAdd DTOs

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

HTTP + OTHER

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

POST /system_entities HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"entity":"String","longDescription":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}