Dynamic Label API Resource

HDC Dynamic Labels Web Service

GET /api/dynamiclabel/json

Get list of dynamic labels.

Response Body
media type data type description
application/json object (JSON) JSON Response with the list of labels.

Example of response:

{"list":[{"labelId":"2","labelName":"Complex data","labelDescription":"Multiple descriptions","showFlags":0},{"labelClassName":"space","labelClassLabel":"Rum","layerName":"BRA","labelId":"1","labelName":"Room data","labelDescription":"Room description","labelClassId":"108","layerId":"2","showFlags":0}]}

Example

Request
GET /api/dynamiclabel/json
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

GET /api/dynamiclabel/json/{drawingId}/{labelId}

Apply dynamic labels to drawing.

Request Parameters
name type description constraints
drawingId path Id of a drawing that presentation is being applied to long
labelId path Label id long
Response Body
media type data type description
application/json HdcSpotsForLabelModelTO (JSON) JSON Response text representation of applied labeling to drawing

Example of response:

{"spots":[{"spotId":"36727","resolvedDetails":[{"id":"54","value":"21764","fieldLabel":"Id"},{"id":"55","value":"99144","fieldLabel":"Name"}]},{"spotId":"36726","resolvedDetails":[{"id":"54","value":"21765","fieldLabel":"Id"},{"id":"55","value":"99145","fieldLabel":"Name"}]},{"spotId":"36728","resolvedDetails":[{"id":"54","value":"21766","fieldLabel":"Id"},{"id":"55","value":"99146","fieldLabel":"Name"}]}],"details":[{"id":"54","name":"Id","sourceClassId":"108","targetFieldName":"hdid","seq":0},{"id":"55","name":"Name","sourceClassId":"108","targetFieldName":"fi2space_name","seq":1}],"label":{"labelId":"39","labelName":"Room data 2","labelDescription":"No background","labelClassId":"108","layerId":"2","showFlags":31},"drawingId":"785","layerId":"2"}

Example

Request
GET /api/dynamiclabel/json/{drawingId}/{labelId}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }