List rule areas
/rule-areascurl -X GET https://api.tst.au.apgpay.dev/rule-areas \
-H "Authorization: Bearer $API_KEY"Return every rule area the platform has registered, each with what it offers.
Permissions
rules:queryRequires the `query` action on `rules` for the supplied runtime context
Query parameters
pageinteger (int32)1-based page number.
limitinteger (int32)Maximum items per page.
columnsarray of RareaColumnColumns to include, in order, when asking for text/csv. Omit for all of them. Sending it with application/json is a 400.
Responses
The response is a tagged shape: type is always "RareaPageAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "RareaPageAttributes"typeenumrequiredRareaViewAttributesruleAreaIdstringrequiredThe area's domain, which names it and is the domain of its policies and named lists.
typeenumrequiredRareaTemplateAttributestemplateIdstringrequiredThe id a rule names the template by.
templateVersioninteger (int32)requiredThe template's version, which a policy keeps for as long as it holds the rule it was made with.
Example 1250
namestringrequiredExample Ada Lovelace
descriptionstringrequiredtypeenumrequiredRareaParameterAttributesparameterIdstringrequiredThe id a rule names the parameter by.
labelstringrequiredvalueTypestringrequiredThe kind of value it takes, as the engine names it: Number, Percent, Money, String, Boolean, DynamicDateRange, List or ListReference. A rule states it as the matching RpolValue.
requiredbooleanrequiredWhether a rule must give it a value. One that is not required and has a default takes the default.
Example true
What it takes when a rule gives it none. Absent when it has no default, or its default is a kind of value the API does not carry.
typeAn amount of money in one currency.
An amount in minor current units of a given currency.
typeenumrequiredIsoCurrencyAmountminorCurrencyUnitsinteger (int64)requiredThe amount in minor currency units (e.g. cents for AUD).
Example 1250
currencyIsoCurrencyrequiredThe currency of the given amount as a 3 letter ISO code.
AFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
PAB, BBD, BYR, BZD, BMD, VEF, BOB, BRL, BND, BGN, BIF, CAD, CVE, KYD, XOF, XAF, XPF, CLP, COP, KMF, CDF, BAM, NIO, CRC, HRK, CUP, CZK, GMD, DKK, MKD, DJF, STD, DOP, VND, XCD, EGP, SVC, ETB, EUR, FKP, FJD, HUF, GHS, GIP, HTG, PYG, GNF, GYD, HKD, UAH, ISK, INR, IRR, IQD, JMD, JOD, KES, PGK, LAK, KWD, MWK, AOA, MMK, GEL, LBP, ALL, HNL, SLL, LRD, LYD, SZL, LSL, MGA, MYR, MUR, MXN, MXV, MDL, MAD, MZN, BOV, NGN, ERN, NAD, NPR, ANG, ILS, TWD, NZD, BTN, KPW, NOK, PEN, MRU, PKR, MOP, TOP, CUC, UYU, PHP, GBP, BWP, QAR, GTQ, ZAR, OMR, KHR, RON, MVR, IDR, RUB, RWF, SHP, SAR, RSD, SCR, SGD, SBD, KGS, SOS, TJS, SSP, LKR, SDG, SRD, SEK, CHF, SYP, BDT, WST, TZS, KZT, TTD, MNT, TND, TRY, TMT, AED, UGX, COU, CLF, UYI, USD, USN, USS, UZS, VUV, CHE, CHW, KRW, YER, JPY, CNY, ZMW, ZWL, PLN
Yes or no.
flagbooleanrequiredExample true
One or more named lists, by id. The lists must be ones the rule's owner may name: its own, or those of a tenant above it.
namedListIdsarray of NlstIdrequiredExample nlst_9f2Kd8QpLzXw
A number.
numbernumberrequiredExample 12.5
Several numbers.
numbersarray of numberExample 12.5
A percentage from 0 to 100.
percentnumberrequiredExample 12.5
Text, such as a name or a code.
textstringrequiredSeveral pieces of text.
textsarray of stringA length of time counted back from the moment a rule is evaluated, such as the last 30 days.
amountinteger (int64)requiredExample 1250
unitRpolWindowUnitrequiredSecondsMinutesHoursDaysWeeksUnknownWhat its value must keep to.
typeA number, percentage or amount no less than this.
minnumberrequiredExample 12.5
A number, percentage or amount no more than this.
maxnumberrequiredExample 12.5
An amount in this currency, so a threshold never compares with money in another.
currencystringrequiredExample AUD
Text, or a choice, among these.
valuesarray of stringlistKindstringFor a parameter that names lists: the kind of list it takes, which is one of the area's listKinds.
typeenumrequiredRareaPresetAttributesnamestringrequiredExample Ada Lovelace
typeenumrequiredRpolArgumentAttributesparameterIdstringrequiredThe parameter's id, as the area's description names it.
typeAn amount of money in one currency.
An amount in minor current units of a given currency.
typeenumrequiredIsoCurrencyAmountminorCurrencyUnitsinteger (int64)requiredThe amount in minor currency units (e.g. cents for AUD).
Example 1250
currencyIsoCurrencyrequiredThe currency of the given amount as a 3 letter ISO code.
AFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
PAB, BBD, BYR, BZD, BMD, VEF, BOB, BRL, BND, BGN, BIF, CAD, CVE, KYD, XOF, XAF, XPF, CLP, COP, KMF, CDF, BAM, NIO, CRC, HRK, CUP, CZK, GMD, DKK, MKD, DJF, STD, DOP, VND, XCD, EGP, SVC, ETB, EUR, FKP, FJD, HUF, GHS, GIP, HTG, PYG, GNF, GYD, HKD, UAH, ISK, INR, IRR, IQD, JMD, JOD, KES, PGK, LAK, KWD, MWK, AOA, MMK, GEL, LBP, ALL, HNL, SLL, LRD, LYD, SZL, LSL, MGA, MYR, MUR, MXN, MXV, MDL, MAD, MZN, BOV, NGN, ERN, NAD, NPR, ANG, ILS, TWD, NZD, BTN, KPW, NOK, PEN, MRU, PKR, MOP, TOP, CUC, UYU, PHP, GBP, BWP, QAR, GTQ, ZAR, OMR, KHR, RON, MVR, IDR, RUB, RWF, SHP, SAR, RSD, SCR, SGD, SBD, KGS, SOS, TJS, SSP, LKR, SDG, SRD, SEK, CHF, SYP, BDT, WST, TZS, KZT, TTD, MNT, TND, TRY, TMT, AED, UGX, COU, CLF, UYI, USD, USN, USS, UZS, VUV, CHE, CHW, KRW, YER, JPY, CNY, ZMW, ZWL, PLN
Yes or no.
flagbooleanrequiredExample true
One or more named lists, by id. The lists must be ones the rule's owner may name: its own, or those of a tenant above it.
namedListIdsarray of NlstIdrequiredExample nlst_9f2Kd8QpLzXw
A number.
numbernumberrequiredExample 12.5
Several numbers.
numbersarray of numberExample 12.5
A percentage from 0 to 100.
percentnumberrequiredExample 12.5
Text, such as a name or a code.
textstringrequiredSeveral pieces of text.
textsarray of stringA length of time counted back from the moment a rule is evaluated, such as the last 30 days.
amountinteger (int64)requiredExample 1250
unitRpolWindowUnitrequiredSecondsMinutesHoursDaysWeeksUnknownactionsarray of stringThe actions a rule of the template may take, each one of the area's actions.
typeenumrequiredRareaFieldAttributesnamestringrequiredThe field's name, which a template compares.
Example Ada Lovelace
valueTypestringrequiredThe kind of value it holds, as the engine names it.
The ways a rule may compare it.
typeenumrequiredRareaOperatorAttributesnamestringrequiredThe operator's name.
Example Ada Lovelace
symbolstringrequiredHow a rule's narrative writes it.
descriptionstringrequiredsensitivityRareaSensitivityrequiredPlainPersonalCardCredentialUnknowntypeenumrequiredRareaActionAttributesnamestringrequiredExample Ada Lovelace
labelstringrequiredtypeenumrequiredRareaActionParameterAttributesparameterIdstringrequiredlabelstringrequiredvalueTypestringrequiredThe kind of value it takes, as the engine names it.
optionsarray of stringThe values it may take, for a setting that is a choice. Empty for one that is not.
requiredbooleanrequiredExample true
What it takes when none is given. Absent when it has no default, or its default is a kind of value the API does not carry.
typeAn amount of money in one currency.
An amount in minor current units of a given currency.
typeenumrequiredIsoCurrencyAmountminorCurrencyUnitsinteger (int64)requiredThe amount in minor currency units (e.g. cents for AUD).
Example 1250
currencyIsoCurrencyrequiredThe currency of the given amount as a 3 letter ISO code.
AFNDZDARSAMDAWGAUDAZNBSDBHDTHB+156 moreShow fewer
PAB, BBD, BYR, BZD, BMD, VEF, BOB, BRL, BND, BGN, BIF, CAD, CVE, KYD, XOF, XAF, XPF, CLP, COP, KMF, CDF, BAM, NIO, CRC, HRK, CUP, CZK, GMD, DKK, MKD, DJF, STD, DOP, VND, XCD, EGP, SVC, ETB, EUR, FKP, FJD, HUF, GHS, GIP, HTG, PYG, GNF, GYD, HKD, UAH, ISK, INR, IRR, IQD, JMD, JOD, KES, PGK, LAK, KWD, MWK, AOA, MMK, GEL, LBP, ALL, HNL, SLL, LRD, LYD, SZL, LSL, MGA, MYR, MUR, MXN, MXV, MDL, MAD, MZN, BOV, NGN, ERN, NAD, NPR, ANG, ILS, TWD, NZD, BTN, KPW, NOK, PEN, MRU, PKR, MOP, TOP, CUC, UYU, PHP, GBP, BWP, QAR, GTQ, ZAR, OMR, KHR, RON, MVR, IDR, RUB, RWF, SHP, SAR, RSD, SCR, SGD, SBD, KGS, SOS, TJS, SSP, LKR, SDG, SRD, SEK, CHF, SYP, BDT, WST, TZS, KZT, TTD, MNT, TND, TRY, TMT, AED, UGX, COU, CLF, UYI, USD, USN, USS, UZS, VUV, CHE, CHW, KRW, YER, JPY, CNY, ZMW, ZWL, PLN
Yes or no.
flagbooleanrequiredExample true
One or more named lists, by id. The lists must be ones the rule's owner may name: its own, or those of a tenant above it.
namedListIdsarray of NlstIdrequiredExample nlst_9f2Kd8QpLzXw
A number.
numbernumberrequiredExample 12.5
Several numbers.
numbersarray of numberExample 12.5
A percentage from 0 to 100.
percentnumberrequiredExample 12.5
Text, such as a name or a code.
textstringrequiredSeveral pieces of text.
textsarray of stringA length of time counted back from the moment a rule is evaluated, such as the last 30 days.
amountinteger (int64)requiredExample 1250
unitRpolWindowUnitrequiredSecondsMinutesHoursDaysWeeksUnknownlistKindsarray of stringThe kinds of entry a named list of this area may hold.
hasMorebooleanrequiredWhether further items exist after this page.
Example true
nextStartingAfterstringId to pass as startingAfter to fetch the next page. Present in cursor mode only.
totalCountinteger (int64)Total items matching the query.
Example 42
pageinteger (int32)The 1-based page returned. Present in offset mode only.
Example 1250
totalPagesinteger (int32)Total pages available. Present in offset mode only.
Example 1250
{
"type": "RareaPageAttributes",
"data": [
{
"type": "RareaViewAttributes",
"ruleAreaId": "string",
"templates": [
{
"type": "RareaTemplateAttributes",
"templateId": "string",
"templateVersion": 1250,
"name": "Ada Lovelace",
"description": "string",
"parameters": [
{
"type": "RareaParameterAttributes",
"parameterId": "string",
"label": "string",
"valueType": "string",
"required": true,
"default": {
"type": "RpolValueAmount",
"amount": {
"type": "IsoCurrencyAmount",
"minorCurrencyUnits": 1250,
"currency": "AUD"
}
},
"bounds": [
{
"type": "RareaBoundAtLeast",
"min": 12.5
}
],
"listKind": "string"
}
],
"presets": [
{
"type": "RareaPresetAttributes",
"name": "Ada Lovelace",
"arguments": [
{
"type": "RpolArgumentAttributes",
"parameterId": "string",
"value": {
"type": "RpolValueAmount",
"amount": {
"type": "IsoCurrencyAmount",
"minorCurrencyUnits": 1250,
"currency": "AUD"
}
}
}
]
}
],
"actions": [
"string"
]
}
],
"fields": [
{
"type": "RareaFieldAttributes",
"name": "Ada Lovelace",
"valueType": "string",
"operators": [
{
"type": "RareaOperatorAttributes",
"name": "Ada Lovelace",
"symbol": "string",
"description": "string"
}
],
"sensitivity": "Plain"
}
],
"actions": [
{
"type": "RareaActionAttributes",
"name": "Ada Lovelace",
"label": "string",
"parameters": [
{
"type": "RareaActionParameterAttributes",
"parameterId": "string",
"label": "string",
"valueType": "string",
"options": [
"string"
],
"required": true,
"default": {
"type": "RpolValueAmount",
"amount": {
"type": "IsoCurrencyAmount",
"minorCurrencyUnits": 1250,
"currency": "AUD"
}
}
}
]
}
],
"listKinds": [
"string"
]
}
],
"hasMore": true,
"nextStartingAfter": "string",
"totalCount": 42,
"page": 1250,
"totalPages": 1250
}Error responses
statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}