Trendsic Platform Service

<back to all web services

QcHoldPointCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/hold-points
"use strict";
export class QcHoldPoint {
    /** @param {{QcHoldPointID?:number,QcHoldPointUID?:string,ProjectID?:number,Description?:string,ResponsibleParty?:string,CostCode?:string,ScheduledDate?:string,Status?:string,ReleasedBy?:string,ReleasedAt?:string,Notes?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    QcHoldPointID;
    /** @type {string} */
    QcHoldPointUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    Description;
    /** @type {string} */
    ResponsibleParty;
    /** @type {string} */
    CostCode;
    /** @type {?string} */
    ScheduledDate;
    /** @type {string} */
    Status;
    /** @type {string} */
    ReleasedBy;
    /** @type {?string} */
    ReleasedAt;
    /** @type {string} */
    Notes;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class QcHoldPointResponse {
    /** @param {{ResponseStatus?:ResponseStatus,HoldPoint?:QcHoldPoint}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {QcHoldPoint} */
    HoldPoint;
}
export class QcHoldPointCreateRequest {
    /** @param {{ProjectID?:number,Description?:string,ResponsibleParty?:string,CostCode?:string,ScheduledDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    Description;
    /** @type {string} */
    ResponsibleParty;
    /** @type {string} */
    CostCode;
    /** @type {?string} */
    ScheduledDate;
}

JavaScript QcHoldPointCreateRequest DTOs

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

HTTP + JSV

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

POST /v1/projects/{ProjectID}/hold-points HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	Description: String,
	ResponsibleParty: String,
	CostCode: String,
	ScheduledDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	HoldPoint: 
	{
		QcHoldPointID: 0,
		QcHoldPointUID: 00000000000000000000000000000000,
		ProjectID: 0,
		Description: String,
		ResponsibleParty: String,
		CostCode: String,
		ScheduledDate: 0001-01-01,
		Status: String,
		ReleasedBy: String,
		ReleasedAt: 0001-01-01,
		Notes: String,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	}
}