GET /api/:space/account/rule-action-helper

Description:

Returns a list of created action helpers.

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/account/rule-action-helper

Request headers

Key	Value	Required
X-API-KEY	Your unique API key	Yes
Content-Type	application/json	Yes

Request URL parameters

Parameter	Type	Required	Description
space	String	Yes	This is the space name which is linked to the account

Additional Query String Parameters

You can use the query parameters along with the generic parameters.

Query parameters

Parameter	Type	Constraint	Usage
name	String	Case insensitive. For lookup you would use "name.raw=search_word" because the field "name" is indexed to support more complex searches	?name.raw=search_word
key	String	Case sensitive	?key=search_word
description	String	Case sensitive	?description=search_word
accountId	String	Case sensitive	?accountId=search_word
system	Boolean	Case sensitive	?system=search_word
unitOfMeasureType	String	Case sensitive	?unitOfMeasureType=search_word (you can find the Enum list in the UnitOfMeasure model)
metadata	Array [Object]	Complex search applies, allows full search on a complex object of Metadata	?metadata.key=search_word ?metadata.value=search_number
created	DateTime	Works with simple dates or date and time, eg: created=2016-02-07, created=2018-08-23T14:23:09	?created=search_DateTime
id	String	Case sensitive	?id=search_string

EXAMPLE

Request

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/account/rule-action-helper

Response

{
    "meta": {
        "totalRecordsFound": 1,
        "skip": 0,
        "limit": 20
    },
    "data": [
        {
            "jsonClass": "RuleActionHelper",
            "name": "bet",
            "key": "bet",
            "description": "bet",
            "accountId": "auyNjGYBZ-qHKtWicaaa",
            "system": false,
            "unitOfMeasureType": "Other",
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "created",
                    "value": "post"
                }
            ],
            "created": "2019-12-16T12:28:34.899+0000",
            "id": "8uSuDm8Brwnis6E2gEXT"
        },
        {
            "jsonClass": "RuleActionHelper",
            "name": "Login",
            "key": "login",
            "description": "Login action",
            "accountId": "auyNjGYBZ-qHKtWicaaa",
            "system": true,
            "metadata": [],
            "created": "2018-10-19T13:39:34.572+0000",
            "id": "HOyNjGYBZ-qHKtWifPws"
        }
    ]
}

Request with Query string parameters

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/account/rule-action-helper?key=bet

Response for query string request

{
    "meta": {
        "totalRecordsFound": 1,
        "skip": 0,
        "limit": 20
    },
    "data": [
        {
            "jsonClass": "RuleActionHelper",
            "name": "bet",
            "key": "bet",
            "description": "",
            "accountId": "auyNjGYBZ-qHKtWicaaa",
            "system": false,
            "unitOfMeasureType": "Other",
            "metadata": [
                {
                    "jsonClass": "Metadata",
                    "key": "created",
                    "value": "post"
                }
            ],
            "created": "2019-12-16T12:28:34.899+0000",
            "id": "8uSuDm8Brwnis6E2gEXT"
        }
    ]
}

ERROR CODES

Code	HTTP Status	Description	Example
	404	Modifying the Resource URL parameters that are mandatory	Error Response 404 Expand source { "status": 404 }