api-docs

API Sections Resource types Resource type Resources Resource Items Item

Item Keyed Data (Budget) - POST

Create a new instance of keyed data.

Request

URL : /v3/resource-types/{resource_type_id}/resources/{resource_id}/items/{item_id}/data

Method : POST

Fields :

Name	Type	Required	Description
key	string	Yes	A unique key for the collection
value	json	Yes	The data to store against the key

Responses

Success

Code : 200 OK

Content :

{
    "key": "Za4Jb370vl",
    "value": {
        "score": {
            "bonus": 35,
            "lower": 104,
            "total": 213,
            "upper": 74
        },
        "lower-section": {
            "chance": 16,
            "yahtzee": 0,
            "full_house": 0,
            "four_of_a_kind": 0,
            "large_straight": 40,
            "small_straight": 30,
            "three_of_a_kind": 18
        },
        "upper-section": {
            "ones": 2,
            "twos": 6,
            "fives": 20,
            "fours": 16,
            "sixes": 18,
            "threes": 12
        }
    },
    "created": "2022-09-06 12:19:15",
    "updated": "2022-09-06 12:42:36"
}

Validation error

Code : 422 OK

Content :

{
    "message": "Validation error.",
    "fields": {
        "key": {
            "errors": [
                "The key must be a string."
            ]
        },
        "value": {
            "errors": [
                "The value should be a valid JSON string."
            ]
        }
    }
}

This site is open source. Improve this page.