ca-orbus-sapi
Objects
GET - /odata/objects
Summary:
Gets Objects and their details.
Description:
Default response includes the list of 50 Objects, which were most recently created in OrbusInfinity, and their top-level properties.
Use the below OData parameters to filter, order, expand additional properties, and select only specified properties in the output.
Query Parameters
| Name | Type | Description |
|---|---|---|
| $select | string | A subset of properties to include for each Object in the response. If left blank, default properties are returned. |
| $expand | string | The additional properties (along with the default ones) to include for each Object in the response. You can additionally request the following properties: Model, ObjectType, AttributeValues, AttributeValuesFlat, CreatedBy, LastModifiedBy, LockedBy, Detail. |
| $filter | string | The expression you filter the Objects in the result by. You can filter Objects by a value for the following properties: ObjectId, Name, ObjectTypeId, LockedOn, LockedById, IsApproved, ModelId, DateCreated, CreatedById, LastModifiedDate, LastModifiedById, Detail, AttributeValues, ObjectType, Model, CreatedBy, LastModifiedBy, LockedBy. The minimum and default number of expressions is 0; the maximum—100 |
| $orderby | string | The order in which Objects are sorted in the response, by a selected property. For example, enter Name desc to request Objects in descending order by property Name. The minimum and default number of expressions is 0; the maximum—5. |
| $top | integer | The count of the Objects, which were most recently created in OrbusInfinity, to include in the response. The minimum value is 0; the maximum—50. For example, enter 20 to return 20 Objects that were most recently created in OrbusInfinity. |
| $skip | integer | The count of the Objects, which were most recently created in OrbusInfinity, to exclude from the response. The minimum and default value is 0; the maximum—50. For example, enter 20 to skip 20 Objects that were most recently created in OrbusInfinity and return the next 50. |
| $count | boolean | If true, the total count of Objects is specified in the response. By default, the parameter is set to false, which means the total count is not returned. |