Trendsic Platform Service

<back to all web services

CloseoutItemPatchRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/projects/{ProjectID}/closeout/{CloseoutItemID}
"use strict";
export class CloseoutItem {
    /** @param {{CloseoutItemID?:number,CloseoutItemUID?:string,ProjectID?:number,ItemKey?:string,Label?:string,Detail?:string,Status?:string,IsApplicable?:boolean,SortOrder?:number,CompletedAt?:string,CompletedBy?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CloseoutItemID;
    /** @type {string} */
    CloseoutItemUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ItemKey;
    /** @type {string} */
    Label;
    /** @type {string} */
    Detail;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    IsApplicable;
    /** @type {number} */
    SortOrder;
    /** @type {?string} */
    CompletedAt;
    /** @type {string} */
    CompletedBy;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class CloseoutStatus {
    /** @param {{ProjectID?:number,TotalItems?:number,DoneCount?:number,OutstandingCount?:number,AllClear?:boolean,RetainageAmount?:number,RetainageReleased?:boolean,ReleasedPayApplicationID?:number,ReleasedInvoiceID?:number,ReleasedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    TotalItems;
    /** @type {number} */
    DoneCount;
    /** @type {number} */
    OutstandingCount;
    /** @type {boolean} */
    AllClear;
    /** @type {number} */
    RetainageAmount;
    /** @type {boolean} */
    RetainageReleased;
    /** @type {?number} */
    ReleasedPayApplicationID;
    /** @type {?number} */
    ReleasedInvoiceID;
    /** @type {?string} */
    ReleasedAt;
}
export class CloseoutListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ProjectID?:number,Items?:CloseoutItem[],Status?:CloseoutStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {number} */
    ProjectID;
    /** @type {CloseoutItem[]} */
    Items = [];
    /** @type {CloseoutStatus} */
    Status;
}
export class CloseoutItemPatchRequest {
    /** @param {{ProjectID?:number,CloseoutItemID?:number,Status?:string,Detail?:string,IsApplicable?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    CloseoutItemID;
    /** @type {string} */
    Status;
    /** @type {string} */
    Detail;
    /** @type {?boolean} */
    IsApplicable;
}

JavaScript CloseoutItemPatchRequest 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.

PUT /v1/projects/{ProjectID}/closeout/{CloseoutItemID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProjectID":0,"CloseoutItemID":0,"Status":"String","Detail":"String","IsApplicable":false}

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

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ProjectID":0,"Items":[{"CloseoutItemID":0,"CloseoutItemUID":"00000000000000000000000000000000","ProjectID":0,"ItemKey":"String","Label":"String","Detail":"String","Status":"String","IsApplicable":false,"SortOrder":0,"CompletedAt":"0001-01-01T00:00:00.0000000","CompletedBy":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"Status":{"ProjectID":0,"TotalItems":0,"DoneCount":0,"OutstandingCount":0,"AllClear":false,"RetainageAmount":0,"RetainageReleased":false,"ReleasedPayApplicationID":0,"ReleasedInvoiceID":0,"ReleasedAt":"0001-01-01T00:00:00.0000000"}}