Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of fraud-risk analysis reports.The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.
curl -X GET -H "API-Key: [[apiKey]]" "http:///identity/fraudRiskReports?start=&limit=&sortBy=&filter=&q=&type="
import { FraudRiskReportsApi } from "@apiture/identity-client-sdk";
const fraudRiskReportsApi = new FraudRiskReportsApi(configuration);
// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
fraudRiskReportsApi.setAccessToken(accessToken)
// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
fraudRiskReportsApi.setApiKey(apiKey);
var api = new Identity.FraudRiskReportsApi.getFraudRiskReports()
var opts = {
'start': 789, // {Long} The zero-based index of the first fraud-risk analysis report in this page. The default, 0, represents the first report in the collection.
'limit': 56, // {Integer} The maximum number of fraud-risk analysis report representations to return in this page.
'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
'type': type_example // {String} Subset the fraud reports collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment` Account matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
fraudRiskReportsApi.getFraudRiskReports(opts, callback);
Name |
Description |
start |
Long
(int64)
The zero-based index of the first fraud-risk analysis report in this page. The default, 0, represents the first report in the collection.
|
limit |
Integer
(int32)
The maximum number of fraud-risk analysis report representations to return in this page.
|
sortBy |
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
|
filter |
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|
q |
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
|
type |
String
Subset the fraud reports collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment` Account matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
|