sfgboxapi

<back to all web services

MediaAdd

The following routes are available for this service:
POST/media
"use strict";
export class MediaAddResponse {
    /** @param {{tenantsId?:number,entity?:string,entityId?:number,mediaType?:string,mediaPath?:string,questionnairsId?:number,name?:string,free?:boolean,publicAccessGuid?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    tenantsId;
    /** @type {string} */
    entity;
    /** @type {number} */
    entityId;
    /** @type {string} */
    mediaType;
    /** @type {?string} */
    mediaPath;
    /** @type {?number} */
    questionnairsId;
    /** @type {string} */
    name;
    /** @type {boolean} */
    free;
    /** @type {string} */
    publicAccessGuid;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class MediaAdd {
    /** @param {{tenantsId?:number,entity?:string,entityId?:number,mediaType?:string,mediaPath?:string,questionnairsId?:number,name?:string,free?:boolean,publicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    tenantsId;
    /** @type {string} */
    entity;
    /** @type {number} */
    entityId;
    /** @type {string} */
    mediaType;
    /** @type {?string} */
    mediaPath;
    /** @type {?number} */
    questionnairsId;
    /** @type {string} */
    name;
    /** @type {boolean} */
    free;
    /** @type {string} */
    publicAccessGuid;
}

JavaScript MediaAdd 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 /media HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"entity":"String","entityId":0,"mediaType":"String","mediaPath":"String","questionnairsId":0,"name":"String","free":false,"publicAccessGuid":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"tenantsId":0,"entity":"String","entityId":0,"mediaType":"String","mediaPath":"String","questionnairsId":0,"name":"String","free":false,"publicAccessGuid":"00000000000000000000000000000000","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}