| GET,OPTIONS | /v1/pins/{EntityType}/{EntityID} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/pins/{EntityType} |
"use strict";
export class SheetPin {
/** @param {{SheetPinID?:number,SheetID?:number,EntityType?:string,EntityID?:number,EntityUID?:string,X?:number,Y?:number,Label?:string,CreatedBy?:string,CreatedAt?:string,EntityNo?:string,EntityTitle?:string,EntityStatus?:string,InspectionUID?:string,SheetNumber?:string,SheetTitle?:string,PlanSetID?:number,PlanSetUID?:string,PlanSetName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SheetPinID;
/** @type {number} */
SheetID;
/** @type {string} */
EntityType;
/** @type {?number} */
EntityID;
/** @type {?string} */
EntityUID;
/** @type {number} */
X;
/** @type {number} */
Y;
/** @type {string} */
Label;
/** @type {string} */
CreatedBy;
/** @type {?string} */
CreatedAt;
/** @type {string} */
EntityNo;
/** @type {string} */
EntityTitle;
/** @type {string} */
EntityStatus;
/** @type {?string} */
InspectionUID;
/** @type {string} */
SheetNumber;
/** @type {string} */
SheetTitle;
/** @type {?number} */
PlanSetID;
/** @type {?string} */
PlanSetUID;
/** @type {string} */
PlanSetName;
}
export class SheetPinListResponse {
/** @param {{ResponseStatus?:ResponseStatus,Pins?:SheetPin[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {SheetPin[]} */
Pins = [];
}
export class PinsForEntityRequest {
/** @param {{EntityType?:string,EntityID?:number,EntityUID?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
EntityType;
/** @type {?number} */
EntityID;
/** @type {?string} */
EntityUID;
}
JavaScript PinsForEntityRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/pins/{EntityType}/{EntityID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
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
}
},
Pins:
[
{
SheetPinID: 0,
SheetID: 0,
EntityType: String,
EntityID: 0,
EntityUID: 00000000000000000000000000000000,
X: 0,
Y: 0,
Label: String,
CreatedBy: String,
CreatedAt: 0001-01-01,
EntityNo: String,
EntityTitle: String,
EntityStatus: String,
InspectionUID: 00000000000000000000000000000000,
SheetNumber: String,
SheetTitle: String,
PlanSetID: 0,
PlanSetUID: 00000000000000000000000000000000,
PlanSetName: String
}
]
}