sfgboxapi

<back to all web services

SystemEntitiesAdd

Requires Authentication
The following routes are available for this service:
POST/system_entities

export class SystemEntitiesAddResponse
{
    // @DataMember(Order=2)
    public entity: string;

    // @DataMember(Order=3)
    public longDescription: string;

    // @DataMember(Order=5)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<SystemEntitiesAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class SystemEntitiesAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public entity: string;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public longDescription: string;

    public constructor(init?: Partial<SystemEntitiesAdd>) { (Object as any).assign(this, init); }
}

TypeScript 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"}}}