Logo
Siemens Xcelerator Developer Portal API Documentation

Get the specifications for an object

GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects/:objid/specs?fields=<string>&nested_names=<string>&recursion_depth=<integer>&overlayid=<string>&lcid=<string>

The fields parameter can have the following valid values:

  • "- The specifications will haveName,Descriptionfields.
  • *- The specifications will haveNestedName,Description,Value,DisplayValue,LValue,SIValue,ControlType,Unit,RangeType,Type,TabIndex,PhysUnitLabel,Precision,Length,Count,LinkObject,StandardTable,XValuesfields.
  • field1,field2" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc
Note: Fields will be filtered out in case they are not a part of the specifications. If all fields specified are invalid, then a BadRequest error will be thrown.


nestednames include the specification nested names. These can include the hierarchical child specifications as well. recursiondepth can have the following values:
  • -1 : will fetch all the specification children until the maximum depth.
  • 0 (default) : will fetch immediate object specifications.
  • 2/3/4...etc : will fetch all the specification children until the specified recursion depth.

 

Body PARAM

Key Datatype Required Description  
fields
 string Fields to be displayed for specifications 
nested_names
 string Nested names of specifications to be included in response 
recursion_depth
 string Specifications children to be fetch until what depth. 
overlayid
 string Working Overlay Id 
lcid
 string Language id



HEADERS

Curl
curl -X GET '//public/api/projects/v1/dbs/:dbid/projects/:projid/objects/:objid/specs?fields=<string>&nested_names=<string>&recursion_depth=<integer>&overlayid=<string>&lcid=<string>?fields=<string>&nested_names=<string>&recursion_depth=<integer>&overlayid=<string>&lcid=<string>' -H 'Comos-API-Session: <string>' -H 'Accept: application/json'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS

    Key Datatype Required Description  
    Comos-API-Session
    		 string