LISTSYNCRESOURCES()`¶

About ListSyncResources¶

Lists the sync resources.

Method Signature¶

METHODS /AWS1/IF_IOM~LISTSYNCRESOURCES
  IMPORTING
    !IV_WORKSPACEID TYPE /AWS1/IOMID OPTIONAL
    !IV_SYNCSOURCE TYPE /AWS1/IOMSYNCSOURCE OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_IOMSYNCRESOURCEFILTER=>TT_SYNCRESOURCEFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOMMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOMNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iomlistsyncresrcsrsp
  RAISING
    /AWS1/CX_IOMACCESSDENIEDEX
    /AWS1/CX_IOMINTERNALSERVEREX
    /AWS1/CX_IOMSERVICEQUOTAEXCDEX
    /AWS1/CX_IOMTHROTTLINGEX
    /AWS1/CX_IOMVALIDATIONEX
    /AWS1/CX_IOMCLIENTEXC
    /AWS1/CX_IOMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspaceid` `TYPE /AWS1/IOMID` `/AWS1/IOMID`¶

The ID of the workspace that contains the sync job.

`iv_syncsource` `TYPE /AWS1/IOMSYNCSOURCE` `/AWS1/IOMSYNCSOURCE`¶

The sync source.

Currently the only supported syncSource is SITEWISE .

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_IOMSYNCRESOURCEFILTER=>TT_SYNCRESOURCEFILTERS` `TT_SYNCRESOURCEFILTERS`¶

A list of objects that filter the request.

The following filter combinations are supported:

Filter with state

Filter with ResourceType and ResourceId

Filter with ResourceType and ExternalId

`iv_maxresults` `TYPE /AWS1/IOMMAXRESULTS` `/AWS1/IOMMAXRESULTS`¶

The maximum number of results to return at one time. The default is 50.

Valid Range: Minimum value of 0. Maximum value of 200.

`iv_nexttoken` `TYPE /AWS1/IOMNEXTTOKEN` `/AWS1/IOMNEXTTOKEN`¶

The string that specifies the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iomlistsyncresrcsrsp` `/AWS1/CL_IOMLISTSYNCRESRCSRSP`¶

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->listsyncresources(
  it_filters = VALUE /aws1/cl_iomsyncresourcefilter=>tt_syncresourcefilters(
    (
      new /aws1/cl_iomsyncresourcefilter(
        iv_externalid = |string|
        iv_resourceid = |string|
        iv_resourcetype = |string|
        iv_state = |string|
      )
    )
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_syncsource = |string|
  iv_workspaceid = |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_syncresources( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_syncresourcetype = lo_row_1->get_resourcetype( ).
      lv_id = lo_row_1->get_externalid( ).
      lv_id = lo_row_1->get_resourceid( ).
      lo_syncresourcestatus = lo_row_1->get_status( ).
      IF lo_syncresourcestatus IS NOT INITIAL.
        lv_syncresourcestate = lo_syncresourcestatus->get_state( ).
        lo_errordetails = lo_syncresourcestatus->get_error( ).
        IF lo_errordetails IS NOT INITIAL.
          lv_errorcode = lo_errordetails->get_code( ).
          lv_errormessage = lo_errordetails->get_message( ).
        ENDIF.
      ENDIF.
      lv_timestamp = lo_row_1->get_updatedatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_IOM=>LISTSYNCRESOURCES()¶