regis

<back to all web services

CRMSharepointFileRequest

Requires Authentication
Required permission:SharepointFiles
The following routes are available for this service:
POST/DynamicsCRM/Sharepoint/File
"use strict";
export class CRMSharepointFileResponse {
    /** @param {{responseStatus?:ResponseStatus,file_base64?:string,filename?:string,item_id?:string,filesize?:number,mimetype?:string,sharepoint_url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    file_base64;
    /** @type {string} */
    filename;
    /** @type {string} */
    item_id;
    /** @type {number} */
    filesize;
    /** @type {string} */
    mimetype;
    /** @type {string} */
    sharepoint_url;
}
export class CRMSharepointFileRequest {
    /** @param {{filename?:string,item_id?:string,convert_to_pdf?:boolean,as_thumbnail?:boolean,is_development?:boolean,is_invoice?:boolean,is_tax_receipt?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    filename;
    /** @type {string} */
    item_id;
    /** @type {boolean} */
    convert_to_pdf;
    /** @type {boolean} */
    as_thumbnail;
    /** @type {boolean} */
    is_development;
    /** @type {boolean} */
    is_invoice;
    /** @type {boolean} */
    is_tax_receipt;
}

JavaScript CRMSharepointFileRequest 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 /DynamicsCRM/Sharepoint/File HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"filename":"String","item_id":"String","convert_to_pdf":false,"as_thumbnail":false,"is_development":false,"is_invoice":false,"is_tax_receipt":false}

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

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"file_base64":"String","filename":"String","item_id":"String","filesize":0,"mimetype":"String","sharepoint_url":"String"}