Get all custom alphabets

In order to get all custom alphabets before a mass data operation, filter[style]=custom MUST be sent as HTTP request path attribute.

All custom alphabets of the current session are returned from the remote service as list in the JSON response body. Each data object of type: alphabet in the list has the same structure as if it had been requested by its identifier via HTTP request path parameter.

Request endpoint

GET SERVER:PORT/api/alphabets?filter[style]=custom

Response status

Request headers

Accept:application/vnd.api+json
Content-Type:application/vnd.api+json
Session-Key:SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS

Response headers

Transfer-Encoding:chunked
Connection:keep-alive
Accept:application/vnd.api+json
Cache-Control:no-cache
Date:Tue, 19 Mar 2024 12:52:24 GMT
Content-Type:application/vnd.api+json
Server:nginx/1.25.4

Request body

# intentionally blank

Response body

{
    "links": {
        "self": "/api/alphabets?filter[style]=custom"
    },
    "data": [
        {
            "attributes": {
                "ascii": true,
                "length": 4,
                "bytes": 4,
                "parity": 0,
                "chars": "bat4"
            },
            "id": "BAT",
            "type": "alphabet"
        },
        {
            "attributes": {
                "ascii": true,
                "length": 3,
                "bytes": 3,
                "parity": 112,
                "chars": "bas"
            },
            "id": "BAS",
            "type": "alphabet"
        },
        {
            "attributes": {
                "ascii": true,
                "length": 3,
                "bytes": 3,
                "parity": 113,
                "chars": "bar"
            },
            "id": "BAR",
            "type": "alphabet"
        }
    ]
}

HTTPie example

$ http get SERVER:PORT/api/alphabets?filter[style]=custom Accept:application/vnd.api+json Content-Type:application/vnd.api+json Session-Key:SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS