1. API
  2. v1
  3. OTHER
  4. GENERAL

Tests

Resource Fields

Name Type Read-only Description
name string
array_items array Array of integers
is_boolean boolean
float_number float
integer_number integer
option string FOO, BAR, ANY or NONE
binary_data binary
user User The user that made this request. Will be null if the request is unauthenticated
updated_at timestamp ISO-8601



Metadata




 
 



Version 1.0
Last Updated August 19, 2016

Actions

Retrieve all tests

GET /api/v1/tests.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
count integer Number of test resources to generate

Default: 1

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,

    "name": "Test 1",
    "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
    "array_items": [
        1,
        2,
        3
    ],
    "is_boolean": true,
    "float_number": 1.23,
    "integer_number": 123,
    "option": "FOO",
    "binary_data": "4pi6",
    "updated_at": "2016-08-18T15:17:39+00:00",

    "resource_type": "test"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/tests/1"

}

        ],
        "resource": "test",
        "limit": 10,
        "total_count": 1
    }

Retrieve a test

GET /api/v1/tests/:id.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
non_existent boolean If specified as true the API will respond with a 404, signalling that the resource doesn't exist. Default: false

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "name": "Test 1",
    "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
    "array_items": [
        1,
        2,
        3
    ],
    "is_boolean": true,
    "float_number": 1.23,
    "integer_number": 123,
    "option": "FOO",
    "binary_data": "4pi6",
    "updated_at": "2016-08-18T15:17:39+00:00",

    "resource_type": "test"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/tests/1"

}
,
        "resource": "test"
    }

Add a test

POST /api/v1/tests.json

Information

Allowed for Public

Parameters

Name Type Mandatory Description
name string
array_items array Array of integers
is_boolean boolean
float_number float
integer_number integer
option string FOO, BAR, ANY or NONE
binary_data binary

Response

    {
        "status": 201,
        "data": {
    "id": 1,

    "name": "Test 1",
    "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
    "array_items": [
        1,
        2,
        3
    ],
    "is_boolean": true,
    "float_number": 1.23,
    "integer_number": 123,
    "option": "FOO",
    "binary_data": "4pi6",
    "updated_at": "2016-08-18T15:17:39+00:00",

    "resource_type": "test"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/tests/1"

}
,
        "resource": "test"
    }

Update a test

PUT /api/v1/tests/:id.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
non_existent boolean If specified as true the API will respond with a 404, signalling that the resource doesn't exist. Default: false

Parameters

Name Type Mandatory Description
name string
array_items array Array of integers
is_boolean boolean
float_number float
integer_number integer
option string FOO, BAR, ANY or NONE
binary_data binary

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "name": "Test 1",
    "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
    "array_items": [
        1,
        2,
        3
    ],
    "is_boolean": true,
    "float_number": 1.23,
    "integer_number": 123,
    "option": "FOO",
    "binary_data": "4pi6",
    "updated_at": "2016-08-18T15:17:39+00:00",

    "resource_type": "test"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/tests/1"

}
,
        "resource": "test"
    }

Update tests

PUT /api/v1/tests.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
ids array
IDs

Parameters

Name Type Mandatory Description
array_items array Array of integers
is_boolean boolean
float_number float
integer_number integer
option string FOO, BAR, ANY or NONE
binary_data binary

Response

{
    "status": 200,
    "total_count": 5
}

Delete a test

DELETE /api/v1/tests/:id.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
non_existent boolean If specified as true the API will respond with a 404, signalling that the resource doesn't exist. Default: false

Response

{
    "status": 200
}

Delete tests

DELETE /api/v1/tests.json

Information

Allowed for Public

Arguments

Name Type Mandatory Description
ids array
List of IDs to be deleted

Response

{
    "status": 200,
    "total_count": 3
}