Logo
Siemens Xcelerator Developer Portal API Documentation

Updates the specifications for an object

PATCH {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects/:objid/specs?fields=<string>&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,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.


Sample request:

        PATCH
        [
            {
                "NestedName":"string",  //Required
                "Value":"string",   
                "SIValue":"double",
                "LinkObject":{
                    "UID":"string",
                    "ProjectUID":"string",
                    "OverlayUID":"string"
                },
                "XValues":[{
                    "Index":"int",
                    "XValue":"string",
                    "SIXValue":"double"
                }]
            }
        ]

 

Body PARAM

Key Datatype Required Description  
fields
 string Fields to be displayed for specifications 
overlayid
 string Working Overlay Id 
lcid
 string Language Id



HEADERS

Curl
curl -X PATCH '//public/api/projects/v1/dbs/:dbid/projects/:projid/objects/:objid/specs?fields=<string>&overlayid=<string>&lcid=<string>?fields=<string>&overlayid=<string>&lcid=<string>' -H 'Comos-API-Session: <string>' -H 'Content-Type: application/x-www-form-urlencoded' -H 'Accept: application/json'

  • FAQs

  • More

    Claim this page

    Report this page

ENDPOINTS

    Key Datatype Required Description  
    Comos-API-Session
    		 string (Required) Comos SessionId that needs to be passed with every request except Login 
    Content-Type
    		 string 
    Accept