Skip to main content
POST
/
items
Create Item
curl --request POST \
  --url https://forgegames.org/api/items \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "name": "<string>",
  "thumbnail": "<string>",
  "rollNumerator": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "classifierOptionIds": [
    "<string>"
  ],
  "itemAttributes": [
    {
      "attributeId": "<string>",
      "min": 123,
      "max": 123
    }
  ]
}'
{
  "id": "<string>",
  "name": "<string>",
  "thumbnail": "<string>",
  "rollNumerator": 123,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "teamId": "<string>",
  "classifiers": [
    {
      "classifierId": "<string>",
      "classifierOption": {
        "id": "<string>",
        "name": "<string>",
        "dropRateMultiplier": 123,
        "classifierId": "<string>"
      }
    }
  ],
  "attributes": [
    {
      "id": "<string>",
      "itemId": "<string>",
      "attributeId": "<string>",
      "min": 123,
      "max": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Creates a item

​
name
string
required
Maximum length: 191
​
rollNumerator
number
required
​
classifierOptionIds
string[]
required

The classifier options to which this item has been assigned

​
itemAttributes
object[]
required
​
id
string
Maximum length: 191
​
thumbnail
string | null
Maximum length: 191
​
createdAt
string
​
updatedAt
string | null

Response

Successful response

​
id
string
required
Maximum length: 191
​
name
string
required
Maximum length: 191
​
thumbnail
string | null
required
Maximum length: 191
​
rollNumerator
number
required
​
createdAt
string
required
​
updatedAt
string | null
required
​
teamId
string
required
Maximum length: 191
​
classifiers
object[]
required
​
attributes
object[]
required