ListRuleAttachmentsParams | ibm-scc

Parameters for the listRuleAttachments operation.

Hierarchy

ListRuleAttachmentsParams

Index

Properties

Optional headers

headers: OutgoingHttpHeaders

Optional limit

limit: number

The number of resources to retrieve. By default, list operations return the first 100 items. To retrieve a different set of items, use limit with offset to page through your available resources.

Usage: If you have 20 rules, and you want to retrieve only the first 5 rules, use ../rules?account_id={account_id}&limit=5.

Optional offset

offset: number

The number of resources to skip. By specifying offset, you retrieve a subset of resources that starts with the offset value. Use offset with limit to page through your available resources.

Usage: If you have 100 rules, and you want to retrieve rules 26 through 50, use ../rules?account_id={account_id}&offset=25&limit=5.

ruleId

ruleId: string

The UUID that uniquely identifies the rule.

Optional transactionId

transactionId: string

The unique identifier that is used to trace an entire request. If you omit this field, the service generates and sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in the trace field of the response body.

Note: To help with debugging logs, it is strongly recommended that you generate and supply a Transaction-Id with each request.