Qodex.ai

Get the specifications for an object

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


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.

Request Params

KeyDatatypeRequiredDescription
fieldsstringFields to be displayed for specifications
nested_namesstringNested names of specifications to be included in response
recursion_depthstringSpecifications children to be fetch until what depth.
overlayidstringWorking Overlay Id
lcidstringLanguage id

HEADERS

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

RESPONSES

status: OK

[{&quot;NestedName&quot;:&quot;et&quot;,&quot;Description&quot;:&quot;occaecat ea voluptate&quot;,&quot;Value&quot;:&quot;tempor&quot;,&quot;DisplayValue&quot;:&quot;id voluptate&quot;,&quot;LValue&quot;:&quot;veniam amet adipisicing ea&quot;,&quot;SIValue&quot;:-2192365.8022668064,&quot;ControlType&quot;:&quot;qui exercitation veniam esse&quot;,&quot;Unit&quot;:&quot;cillum officia sunt&quot;,&quot;RangeType&quot;:31719451,&quot;Type&quot;:&quot;Duis eu ipsum&quot;,&quot;TabIndex&quot;:-52880206,&quot;PhysUnitLabel&quot;:&quot;ut sunt laborum elit&quot;,&quot;Precision&quot;:71050075,&quot;Length&quot;:-12511040,&quot;Count&quot;:-64144368,&quot;StandardTable&quot;:{&quot;UID&quot;:&quot;u&quot;},&quot;LinkObject&quot;:{&quot;UID&quot;:&quot;tempor et exercitation&quot;,&quot;ProjectUID&quot;:&quot;et ad enim eiusmod&quot;,&quot;OverlayUID&quot;:&quot;officia velit veniam&quot;},&quot;XValues&quot;:[{&quot;Index&quot;:-28388957,&quot;XValue&quot;:&quot;tempor ut veniam&quot;,&quot;DisplayXValue&quot;:&quot;sit&quot;,&quot;LXValue&quot;:&quot;laborum exercitation&quot;,&quot;SIXValue&quot;:6720454.918124214},{&quot;Index&quot;:-92710584,&quot;XValue&quot;:&quot;voluptate sed&quot;,&quot;DisplayXValue&quot;:&quot;minim qui ea do quis&quot;,&quot;LXValue&quot;:&quot;Ut&quot;,&quot;SIXValue&quot;:49682384.691406965}]},{&quot;NestedName&quot;:&quot;ut in qui&quot;,&quot;Description&quot;:&quot;eu id pariatu&quot;,&quot;Value&quot;:&quot;ut Ex&quot;,&quot;DisplayValue&quot;:&quot;sit nulla Ut&quot;,&quot;LValue&quot;:&quot;aliquip officia&quot;,&quot;SIValue&quot;:53829575.883582205,&quot;ControlType&quot;:&quot;ad culpa nostrud Lorem&quot;,&quot;Unit&quot;:&quot;ad tempor dolore Excepteur&quot;,&quot;RangeType&quot;:-14052091,&quot;Type&quot;:&quot;tempor enim&quot;,&quot;TabIndex&quot;:-41578357,&quot;PhysUnitLabel&quot;:&quot;ex laboris ut labor&quot;,&quot;Precision&quot;:41963182,&quot;Length&quot;:-87276903,&quot;Count&quot;:-51623317,&quot;StandardTable&quot;:{&quot;UID&quot;:&quot;cillum aute deserunt&quot;},&quot;LinkObject&quot;:{&quot;UID&quot;:&quot;incididunt&quot;,&quot;ProjectUID&quot;:&quot;et&quot;,&quot;OverlayUID&quot;:&quot;qui proident et culpa&quot;},&quot;XValues&quot;:[{&quot;Index&quot;:24035136,&quot;XValue&quot;:&quot;commodo enim in&quot;,&quot;DisplayXValue&quot;:&quot;qui et ipsum aliquip&quot;,&quot;LXValue&quot;:&quot;esse aliqua culpa tempor&quot;,&quot;SIXValue&quot;:-1140376.1703260094},{&quot;Index&quot;:31777219,&quot;XValue&quot;:&quot;consequat ullamco qui adipisicing&quot;,&quot;DisplayXValue&quot;:&quot;tempor voluptate&quot;,&quot;LXValue&quot;:&quot;irure cupidatat&quot;,&quot;SIXValue&quot;:-40964580.5122774}]}]