UPDATECAMPAIGN()`¶

About UpdateCampaign¶

Updates a campaign.

Method Signature¶

METHODS /AWS1/IF_IOI~UPDATECAMPAIGN
  IMPORTING
    !IV_NAME TYPE /AWS1/IOICAMPAIGNNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IOIDESCRIPTION OPTIONAL
    !IT_DATAEXTRADIMENSIONS TYPE /AWS1/CL_IOIDATAEXTRADIMENSI00=>TT_DATAEXTRADIMENSIONNODEPAT00 OPTIONAL
    !IV_ACTION TYPE /AWS1/IOIUPDATECAMPAIGNACTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioiupdatecampaignrsp
  RAISING
    /AWS1/CX_IOIINTERNALSERVEREX
    /AWS1/CX_IOIACCESSDENIEDEX
    /AWS1/CX_IOICONFLICTEXCEPTION
    /AWS1/CX_IOIRESOURCENOTFOUNDEX
    /AWS1/CX_IOITHROTTLINGEX
    /AWS1/CX_IOIVALIDATIONEX
    /AWS1/CX_IOICLIENTEXC
    /AWS1/CX_IOISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/IOICAMPAIGNNAME` `/AWS1/IOICAMPAIGNNAME`¶

The name of the campaign to update.

`iv_action` `TYPE /AWS1/IOIUPDATECAMPAIGNACTION` `/AWS1/IOIUPDATECAMPAIGNACTION`¶

Specifies how to update a campaign. The action can be one of the following:

APPROVE - To approve delivering a data collection scheme to vehicles.

SUSPEND - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data.

RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.

UPDATE - To update a campaign.

Optional arguments:¶

`iv_description` `TYPE /AWS1/IOIDESCRIPTION` `/AWS1/IOIDESCRIPTION`¶

The description of the campaign.

`it_dataextradimensions` `TYPE /AWS1/CL_IOIDATAEXTRADIMENSI00=>TT_DATAEXTRADIMENSIONNODEPAT00` `TT_DATAEXTRADIMENSIONNODEPAT00`¶

A list of vehicle attributes to associate with a signal.

Default: An empty array

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioiupdatecampaignrsp` `/AWS1/CL_IOIUPDATECAMPAIGNRSP`¶

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->updatecampaign(
  it_dataextradimensions = VALUE /aws1/cl_ioidataextradimensi00=>tt_dataextradimensionnodepat00(
    ( new /aws1/cl_ioidataextradimensi00( |string| ) )
  )
  iv_action = |string|
  iv_description = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_campaignarn = lo_result->get_arn( ).
  lv_campaignname = lo_result->get_name( ).
  lv_campaignstatus = lo_result->get_status( ).
ENDIF.

/AWS1/IF_IOI=>UPDATECAMPAIGN()¶