Logo
Siemens Xcelerator Developer Portal API Documentation

Gets the object properties

GET {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/object?pathfullname=<string>&fields=<string>&overlayid=<string>&lcid=<string>

Object is fetched based on the object's path full name. The fields parameter can have the following valid values:

  • "- Default set of fields for the object.
  • *- Full set of fields for the object.
  • field1,field2- Valid set of fields separated by comma for the object. ex. Name,Description,...,etc
Note: Fields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.

Fields supported by Objects based on the object type:

border:1px solid #000;word-break:break-all;padding:5px;>
width:15%;>Object Typewidth:40%;>Default Fieldswidth:45%;>All Fields
width:10%;>CDevicewidth:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExistwidth:50%;>Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel
width:10%;>Devicewidth:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,Location,Unitwidth:50%;>Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Devices,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel
width:10%;>Documentwidth:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentTypewidth:50%;>Name,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Documents,Devices
width:10%;>Other Typeswidth:40%;>Name,Description,FullLabel,SystemType,UID,SystemUIDwidth:50%;">Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist

 

Body PARAM

Key Datatype Required Description  
pathfullname
 string (Required) Path full name 
fields
 string Fields to reduce the retrieved properties to 
overlayid
 string Working Overlay Id 
lcid
 string Language Id



HEADERS

Key Datatype Required Description  
Comos-API-Session
Curl
curl -X GET '//public/api/projects/v1/dbs/:dbid/projects/:projid/object?pathfullname=<string>&fields=<string>&overlayid=<string>&lcid=<string>?pathfullname=<string>&fields=<string>&overlayid=<string>&lcid=<string>' -H 'Comos-API-Session: <string>' -H 'Accept: application/json'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS