Skip to content

/AWS1/IF_PTC=>LISTRELATIONSHIPS()

About ListRelationships

Lists partner relationships based on specified criteria.

Method Signature

METHODS /AWS1/IF_PTC~LISTRELATIONSHIPS
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTCCATALOG OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PTCINTEGER OPTIONAL
    !IT_ASSOCIATEDACCOUNTIDS TYPE /AWS1/CL_PTCACCOUNTIDLIST_W=>TT_ACCOUNTIDLIST OPTIONAL
    !IT_ASSOCIATIONTYPES TYPE /AWS1/CL_PTCASSOCTYPELIST_W=>TT_ASSOCIATIONTYPELIST OPTIONAL
    !IT_DISPLAYNAMES TYPE /AWS1/CL_PTCRELATIONSHIPDSPN00=>TT_RELATIONSHIPDISPLAYNAMELIST OPTIONAL
    !IT_PROGRAMMNGMTACCOUNTIDS TYPE /AWS1/CL_PTCPROGRAMMGTACIDLS00=>TT_PROGRAMMNGMTACCOUNTIDLIST OPTIONAL
    !IO_SORT TYPE REF TO /AWS1/CL_PTCLSTRELATIONSHIPS01 OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PTCNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptclstrelationships02
  RAISING
    /AWS1/CX_PTCACCESSDENIEDEX
    /AWS1/CX_PTCINTERNALSERVEREX
    /AWS1/CX_PTCRESOURCENOTFOUNDEX
    /AWS1/CX_PTCTHROTTLINGEX
    /AWS1/CX_PTCVLDTNEXCEPTION
    /AWS1/CX_PTCCLIENTEXC
    /AWS1/CX_PTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_catalog TYPE /AWS1/PTCCATALOG /AWS1/PTCCATALOG

The catalog identifier to filter relationships.

Optional arguments:

iv_maxresults TYPE /AWS1/PTCINTEGER /AWS1/PTCINTEGER

The maximum number of results to return in a single call.

it_associatedaccountids TYPE /AWS1/CL_PTCACCOUNTIDLIST_W=>TT_ACCOUNTIDLIST TT_ACCOUNTIDLIST

Filter by associated AWS account IDs.

it_associationtypes TYPE /AWS1/CL_PTCASSOCTYPELIST_W=>TT_ASSOCIATIONTYPELIST TT_ASSOCIATIONTYPELIST

Filter by association types.

it_displaynames TYPE /AWS1/CL_PTCRELATIONSHIPDSPN00=>TT_RELATIONSHIPDISPLAYNAMELIST TT_RELATIONSHIPDISPLAYNAMELIST

Filter by display names.

it_programmngmtaccountids TYPE /AWS1/CL_PTCPROGRAMMGTACIDLS00=>TT_PROGRAMMNGMTACCOUNTIDLIST TT_PROGRAMMNGMTACCOUNTIDLIST

Filter by program management account identifiers.

io_sort TYPE REF TO /AWS1/CL_PTCLSTRELATIONSHIPS01 /AWS1/CL_PTCLSTRELATIONSHIPS01

Sorting options for the results.

iv_nexttoken TYPE /AWS1/PTCNEXTTOKEN /AWS1/PTCNEXTTOKEN

Token for retrieving the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ptclstrelationships02 /AWS1/CL_PTCLSTRELATIONSHIPS02

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->listrelationships(
  io_sort = new /aws1/cl_ptclstrelationships01(
    iv_sortby = |string|
    iv_sortorder = |string|
  )
  it_associatedaccountids = VALUE /aws1/cl_ptcaccountidlist_w=>tt_accountidlist(
    ( new /aws1/cl_ptcaccountidlist_w( |string| ) )
  )
  it_associationtypes = VALUE /aws1/cl_ptcassoctypelist_w=>tt_associationtypelist(
    ( new /aws1/cl_ptcassoctypelist_w( |string| ) )
  )
  it_displaynames = VALUE /aws1/cl_ptcrelationshipdspn00=>tt_relationshipdisplaynamelist(
    ( new /aws1/cl_ptcrelationshipdspn00( |string| ) )
  )
  it_programmngmtaccountids = VALUE /aws1/cl_ptcprogrammgtacidls00=>tt_programmngmtaccountidlist(
    ( new /aws1/cl_ptcprogrammgtacidls00( |string| ) )
  )
  iv_catalog = |string|
  iv_maxresults = 123
  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_items( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_arn = lo_row_1->get_arn( ).
      lv_relationshipid = lo_row_1->get_id( ).
      lv_revision = lo_row_1->get_revision( ).
      lv_catalog = lo_row_1->get_catalog( ).
      lv_associationtype = lo_row_1->get_associationtype( ).
      lv_programmanagementaccoun = lo_row_1->get_programmngmtaccountid( ).
      lv_accountid = lo_row_1->get_associatedaccountid( ).
      lv_relationshipdisplayname = lo_row_1->get_displayname( ).
      lv_sector = lo_row_1->get_sector( ).
      lv_datetime = lo_row_1->get_createdat( ).
      lv_datetime = lo_row_1->get_updatedat( ).
      lv_datetime = lo_row_1->get_startdate( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

Example for ListRelationships

Example for ListRelationships

DATA(lo_result) = lo_client->listrelationships(
  io_sort = new /aws1/cl_ptclstrelationships01(
    iv_sortby = |UpdatedAt|
    iv_sortorder = |Descending|
  )
  it_associatedaccountids = VALUE /aws1/cl_ptcaccountidlist_w=>tt_accountidlist(
    ( new /aws1/cl_ptcaccountidlist_w( |123456789012| ) )
  )
  it_associationtypes = VALUE /aws1/cl_ptcassoctypelist_w=>tt_associationtypelist(
    ( new /aws1/cl_ptcassoctypelist_w( |DOWNSTREAM_SELLER| ) )
  )
  it_displaynames = VALUE /aws1/cl_ptcrelationshipdspn00=>tt_relationshipdisplaynamelist(
    ( new /aws1/cl_ptcrelationshipdspn00( |TestDisplayName| ) )
  )
  it_programmngmtaccountids = VALUE /aws1/cl_ptcprogrammgtacidls00=>tt_programmngmtaccountidlist(
    ( new /aws1/cl_ptcprogrammgtacidls00( |pma-u8ic702rtzng8| ) )
  )
  iv_catalog = |AWS|
  iv_maxresults = 100
  iv_nexttoken = |nextToken|
).