Create new object under the existing object

POST {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects?overlayid=<string>&lcid=<string>&fields=<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
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,Description2,Description3,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,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel
width:10%;>Documentwidth:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentTypewidth:50%;>Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,CObject
width:10%;>Other Typeswidth:40%;>Name,Description,FullLabel,SystemType,UID,SystemUIDwidth:50%;">Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist

Sample request for Device Object:

        POST
        {
            "Name":"string",
            "Description":"string",
            "Label":"string",
            "CDevice":{
                "UID":"string"
            },
            "Owner":{   //Required
                "UID":"string"
            }
        }       

        Sample request for Document Object:
        POST
        {
            "Name":"string",
            "Description":"string",
            "Description2":"string",
            "Description3":"string",
            "Label":"string",
            "CObject":{  
                "UID":"string"
            },
            "DocumentType":{
                "UID":"string"
            },
            "OrgDocument":{
                "UID":"string"
            },
            "Owner":{   //Required
                "UID":"string"
            }
        }

Request Params

KeyDatatypeRequiredDescription
overlayidstringWorking Overlay Id
lcidstringLanguage Id
fieldsstringFields to reduce the retrieved properties to

HEADERS

KeyDatatypeRequiredDescription
Comos-API-Sessionstring(Required) Comos SessionId that needs to be passed with every request except Login
Content-Typestring
Acceptstring

RESPONSES

status: Created

{}