Updates the given object

POST {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects/actions/bulk/patch?fields=<string>&nested_names=<string>&recursion_depth=<integer>&overlayid=<string>&lcid=<string>

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
Specifications(Name,value,...)- Special keyword Specifications to filter on specifications level

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.

nested_names include the specification nested names. These can include the hierarchical child specifications as well. recursion_depth 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.

Fields supported by Objects based on the object type:

border:1px solid #000;word-break:break-all;padding:5px;>

width:15%;>Object Type	width:40%;>Default Fields	width:45%;>All Fields
width:10%;>CDevice	width:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist	width:50%;>Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel,Specifications
width:10%;>Device	width:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit	width:50%;>Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel,Specifications
width:10%;>Document	width:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType	width:50%;>Name,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Specifications
width:10%;>Specifications	width:40%;>Name,Description	width:50%;>NestedName,Description,Value,DisplayValue,LValue,SIValue,ControlType,Unit,RangeType,Type,TabIndex,PhysUnitLabel,Precision,Length,Count,LinkObject,XValues,Specifications
width:10%;>Other Types	width:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID	width:50%;">Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Specifications

Sample request:

        POST
        [
            {   
               "UID": "string",
               "Specifications": [{
                   "NestedName": "string",
                   "Value": "string",
                   "SIValue": "double",
                   "LinkObject": {
                       "UID": "string",
                       "ProjectUID": "string",
                       "OverlayUID": "string"
                   },
                   "XValues": [
                   {
                       "Index": "int",
                       "XValue": "string",
                       "SIXValue": "double"
                   }
                   ]
                }],
                "Name": "string",
                "Description": "string",
                "Label": "string",
                "CDevice": {
                    "UID": "string"
                },
                "OrgDocument":{
                    "UID":"string"
                },
                "Owner": {
                    "UID": "string"
                }
            },
            {   //Sample request for Document
               "UID": "string",
               "Specifications": [{
                   "NestedName": "string",
                   "Value": "string",
                   "SIValue": "double",
                   "LinkObject": {
                       "UID": "string",
                       "ProjectUID": "string",
                       "OverlayUID": "string"
                   },
                   "XValues": [
                   {
                       "Index": "int",
                       "XValue": "string",
                       "SIXValue": "double"
                   }
                   ]
                }],
                "Name":"string",
                "Description":"string",
                "Description2":"string",
                "Description3":"string",
                "Label":"string",
                "CObject":{
                    "UID":"string"
                 },
                "DocumentType":{
                    "UID":"string"
                },
                "OrgDocument":{
                    "UID":"string"
                },
                "Owner":{
                    "UID":"string"
                }
            }
        ]

Request Params

Key	Datatype	Description
`fields`	string	Fields to return in the response after update
`nested_names`	string	List of specification nested names to return after update
`recursion_depth`	string	Specifications children to be fetch until what depth.
`overlayid`	string	Working Overlay Id
`lcid`	string	Language Id

HEADERS

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

RESPONSES

status: OK

{}