1. REST API for Automotive in Oracle Fusion Cloud CX for Industries
  2. Tasks
  3. Vehicles

Get all Vehicles

get

/crmRestApi/resources/11.13.18.05/autoVehicles

Request

Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • RowFinder: Finder Variables:
      • VehicleIdentificationNumber; string;
    • PrimaryKey: Finder Variables:
      • VehicleId; integer;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : autoVehicles
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : autoVehicles-item
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, update, or delete an attachment.
Show Source
Nested Schema : Vehicle Finances
Type: array
Title: Vehicle Finances
The vehicle finances resource is used to view, create, update, or delete a vehicle finance.
Show Source
Nested Schema : Vehicle KPIs
Type: array
Title: Vehicle KPIs
The vehicle KPIs resource is used to view, create, update, or delete a vehicle KPI.
Show Source
Nested Schema : Vehicle Marketing Cards
Type: array
Title: Vehicle Marketing Cards
The vehicle marketing cards resource is used to view, create, update, or delete a vehicle marketing card.
Show Source
Nested Schema : Vehicle Options
Type: array
Title: Vehicle Options
The vehicle optional resource is used to view, create, update, or delete a vehicle optional.
Show Source
Nested Schema : Vehicle Owners
Type: array
Title: Vehicle Owners
The vehicle ownership resource is used to view, create, update, or delete a vehicle ownership.
Show Source
Nested Schema : Vehicle Plates
Type: array
Title: Vehicle Plates
The vehicle plates resource is used to view, create, update, or delete a vehicle plate.
Show Source
Nested Schema : Vehicle Sales
Type: array
Title: Vehicle Sales
The vehicle sales resource is used to view, create, update, or delete a vehicle sale.
Show Source
Nested Schema : Vehicle Service Entries
Type: array
Title: Vehicle Service Entries
The vehicle service entries resource is used to view, create, update, or delete a vehicle service entry.
Show Source
Nested Schema : Vehicle Service Warranties
Type: array
Title: Vehicle Service Warranties
The vehicle warranties resource is used to view, create, update, or delete a vehicle warranty.
Show Source
Nested Schema : autoVehicles-Attachments-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleFinances-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleIoTKpis-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleMarketingCards-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleOptionals-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleOwnerships-item
Type: object
Show Source
Nested Schema : autoVehicles-VehiclePlates-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleSales-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleServiceEntries-item
Type: object
Show Source
Nested Schema : autoVehicles-VehicleWarranties-item
Type: object
Show Source
Back to Top