Qodex.ai

Gets up to 1000 COMOS objects with given fields and specification information.

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

Objects is fetched based on an array of object UIDs. 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 seperated 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.
nestednames and recursiondepth are applicable for 'Specifications' field which needs to be explicitly passed or will be available with ''.
Fields supported by Objects based on the object type:


nestednames include the specification nested names. These can include the hierarchical child specifications as well. recursiondepth 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.
Object TypeDefault FieldsAll Fields
CDeviceName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExistName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel,Specifications
DeviceName,Description,FullLabel,SystemType,UID,SystemUID,Location,UnitName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Devices,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel,Specifications
DocumentName,Description,Description2,Description3,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentTypeName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Documents,Devices,Specifications,CObject
DocObjName,Description,FullLabel,SystemType,UID,SystemUID,Reference,Reference2Name,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Reference,Reference2
Other TypesName,Description,FullLabel,SystemType,UID,SystemUIDName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Specifications

Request Params

KeyDatatypeRequiredDescription
fieldsstringFields to reduce the retrieved properties to
nested_namesstringSpecification nested names that should be returned additionally to the fields
recursion_depthstringSpecifications children to be fetch until what depth.
overlayidstringWorking Overlay Id
lcidstringLanguage Id

Request Body

[{"name"=>"UID", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"UID", "value"=>"<string>", "datatype"=>"string"}]

HEADERS

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

RESPONSES

status: OK

{}