Trendsic Platform Service

<back to all web services

PinsForEntityRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/pins/{EntityType}/{EntityID}
GET,OPTIONS/v1/pins/{EntityType}
PinsForEntityRequest Parameters:
NameParameterData TypeRequiredDescription
EntityTypepathstringNo
EntityIDpathint?No
EntityUIDqueryGuid?No
SheetPinListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PinsformList<SheetPin>No
SheetPin Parameters:
NameParameterData TypeRequiredDescription
SheetPinIDformintNo
SheetIDformintNo
EntityTypeformstringNo
EntityIDformint?No
EntityUIDformGuid?No
XformdoubleNo
YformdoubleNo
LabelformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
EntityNoformstringNo
EntityTitleformstringNo
EntityStatusformstringNo
InspectionUIDformGuid?No
SheetNumberformstringNo
SheetTitleformstringNo
PlanSetIDformint?No
PlanSetUIDformGuid?No
PlanSetNameformstringNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","EntityNo":"String","EntityTitle":"String","EntityStatus":"String","InspectionUID":"00000000000000000000000000000000","SheetNumber":"String","SheetTitle":"String","PlanSetID":0,"PlanSetUID":"00000000000000000000000000000000","PlanSetName":"String"}]}