/AWS1/CL_ADS=>DESCRIBEAGENTS()

About DescribeAgents

Lists agents or collectors as specified by ID or other filters. All agents/collectors associated with your user can be listed if you call DescribeAgents as is without passing any parameters.

Method Signature

IMPORTING

Optional arguments:

IT_AGENTIDS TYPE /AWS1/CL_ADSAGENTIDS_W=>TT_AGENTIDS TT_AGENTIDS

The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

IT_FILTERS TYPE /AWS1/CL_ADSFILTER=>TT_FILTERS TT_FILTERS

You can filter the request using various logical operators and a key-value format. For example:

{"key": "collectionStatus", "value": "STARTED"}

IV_MAXRESULTS TYPE /AWS1/ADSINTEGER /AWS1/ADSINTEGER

The total number of agents/collectors to return in a single page of output. The maximum value is 100.

IV_NEXTTOKEN TYPE /AWS1/ADSNEXTTOKEN /AWS1/ADSNEXTTOKEN

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_ADSDESCRAGENTSRSP /AWS1/CL_ADSDESCRAGENTSRSP