Skip to content

/AWS1/IF_IOI=>LISTVEHICLES()

About ListVehicles

Retrieves a list of summaries of created vehicles.

This API operation uses pagination. Specify the nextToken parameter in the request to return more results.

Method Signature

METHODS /AWS1/IF_IOI~LISTVEHICLES
  IMPORTING
    !IV_MODELMANIFESTARN TYPE /AWS1/IOIARN OPTIONAL
    !IT_ATTRIBUTENAMES TYPE /AWS1/CL_IOIATTRNAMESLIST_W=>TT_ATTRIBUTENAMESLIST OPTIONAL
    !IT_ATTRIBUTEVALUES TYPE /AWS1/CL_IOIATTRVALUESLIST_W=>TT_ATTRIBUTEVALUESLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOINEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOILISTVEHICLESMAXRSLTS OPTIONAL
    !IV_LISTRESPONSESCOPE TYPE /AWS1/IOILISTRESPONSESCOPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioilistvehiclesrsp
  RAISING
    /AWS1/CX_IOIINTERNALSERVEREX
    /AWS1/CX_IOIACCESSDENIEDEX
    /AWS1/CX_IOITHROTTLINGEX
    /AWS1/CX_IOIVALIDATIONEX
    /AWS1/CX_IOICLIENTEXC
    /AWS1/CX_IOISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_modelmanifestarn TYPE /AWS1/IOIARN /AWS1/IOIARN

The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional parameter to list only the vehicles created from a certain vehicle model.

it_attributenames TYPE /AWS1/CL_IOIATTRNAMESLIST_W=>TT_ATTRIBUTENAMESLIST TT_ATTRIBUTENAMESLIST

The fully qualified names of the attributes. You can use this optional parameter to list the vehicles containing all the attributes in the request. For example, attributeNames could be "Vehicle.Body.Engine.Type, Vehicle.Color" and the corresponding attributeValues could be "1.3 L R2, Blue" . In this case, the API will filter vehicles with an attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filters to return the subset of vehicles that match the attributes filter condition.

it_attributevalues TYPE /AWS1/CL_IOIATTRVALUESLIST_W=>TT_ATTRIBUTEVALUESLIST TT_ATTRIBUTEVALUESLIST

Static information about a vehicle attribute value in string format. You can use this optional parameter in conjunction with attributeNames to list the vehicles containing all the attributeValues corresponding to the attributeNames filter. For example, attributeValues could be "1.3 L R2, Blue" and the corresponding attributeNames filter could be "Vehicle.Body.Engine.Type, Vehicle.Color". In this case, the API will filter vehicles with attribute name Vehicle.Body.Engine.Type that contains a value of 1.3 L R2 AND an attribute name Vehicle.Color that contains a value of "Blue". A request must contain unique values for the attributeNames filter and the matching number of attributeValues filter to return the subset of vehicles that match the attributes filter condition.

iv_nexttoken TYPE /AWS1/IOINEXTTOKEN /AWS1/IOINEXTTOKEN

A pagination token for the next set of results.

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

iv_maxresults TYPE /AWS1/IOILISTVEHICLESMAXRSLTS /AWS1/IOILISTVEHICLESMAXRSLTS

The maximum number of items to return, between 1 and 100, inclusive.

iv_listresponsescope TYPE /AWS1/IOILISTRESPONSESCOPE /AWS1/IOILISTRESPONSESCOPE

When you set the listResponseScope parameter to METADATA_ONLY, the list response includes: vehicle name, Amazon Resource Name (ARN), creation time, and last modification time.

RETURNING

oo_output TYPE REF TO /aws1/cl_ioilistvehiclesrsp /AWS1/CL_IOILISTVEHICLESRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listvehicles(
  it_attributenames = VALUE /aws1/cl_ioiattrnameslist_w=>tt_attributenameslist(
    ( new /aws1/cl_ioiattrnameslist_w( |string| ) )
  )
  it_attributevalues = VALUE /aws1/cl_ioiattrvalueslist_w=>tt_attributevalueslist(
    ( new /aws1/cl_ioiattrvalueslist_w( |string| ) )
  )
  iv_listresponsescope = |string|
  iv_maxresults = 123
  iv_modelmanifestarn = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_vehiclesummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_vehiclename = lo_row_1->get_vehiclename( ).
      lv_arn = lo_row_1->get_arn( ).
      lv_arn = lo_row_1->get_modelmanifestarn( ).
      lv_arn = lo_row_1->get_decodermanifestarn( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodificationtime( ).
      LOOP AT lo_row_1->get_attributes( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_attributevalue = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.