Create new object under the existing object
POST {{baseUrl}}/public/api/projects/v1/dbs/:dbid/projects/:projid/objects?overlayid=<string>&lcid=<string>&fields=<string>
- "
- 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
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,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel |
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 |
width:10%;>Document | width:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType | width: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 Types | width:40%;>Name,Description,FullLabel,SystemType,UID,SystemUID | width: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
Key | Datatype | Required | Description |
---|---|---|---|
overlayid | string | Working Overlay Id | |
lcid | string | Language Id | |
fields | string | Fields to reduce the retrieved properties to |
HEADERS
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 | string |
RESPONSES
status: Created
{}