Create an Item Instance
curl --request POST \
--url https://forgegames.org/api/item-instances \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"itemId": "<string>",
"itemAttributeInstances": [
{
"itemAttributeId": "<string>",
"value": 123
}
],
"userId": "<string>",
"userSpaceId": "<string>"
}
'import requests
url = "https://forgegames.org/api/item-instances"
payload = {
"itemId": "<string>",
"itemAttributeInstances": [
{
"itemAttributeId": "<string>",
"value": 123
}
],
"userId": "<string>",
"userSpaceId": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
itemId: '<string>',
itemAttributeInstances: [{itemAttributeId: '<string>', value: 123}],
userId: '<string>',
userSpaceId: '<string>'
})
};
fetch('https://forgegames.org/api/item-instances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://forgegames.org/api/item-instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'itemId' => '<string>',
'itemAttributeInstances' => [
[
'itemAttributeId' => '<string>',
'value' => 123
]
],
'userId' => '<string>',
'userSpaceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://forgegames.org/api/item-instances"
payload := strings.NewReader("{\n \"itemId\": \"<string>\",\n \"itemAttributeInstances\": [\n {\n \"itemAttributeId\": \"<string>\",\n \"value\": 123\n }\n ],\n \"userId\": \"<string>\",\n \"userSpaceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://forgegames.org/api/item-instances")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"itemId\": \"<string>\",\n \"itemAttributeInstances\": [\n {\n \"itemAttributeId\": \"<string>\",\n \"value\": 123\n }\n ],\n \"userId\": \"<string>\",\n \"userSpaceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://forgegames.org/api/item-instances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"itemId\": \"<string>\",\n \"itemAttributeInstances\": [\n {\n \"itemAttributeId\": \"<string>\",\n \"value\": 123\n }\n ],\n \"userId\": \"<string>\",\n \"userSpaceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"itemId": "<string>",
"teamId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}item-instances
Create an Item Instance
Creates an instance of an item within the specified team. Instances are generated from item templates and can have custom attributes and configurations.
POST
/
item-instances
Create an Item Instance
curl --request POST \
--url https://forgegames.org/api/item-instances \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"itemId": "<string>",
"itemAttributeInstances": [
{
"itemAttributeId": "<string>",
"value": 123
}
],
"userId": "<string>",
"userSpaceId": "<string>"
}
'import requests
url = "https://forgegames.org/api/item-instances"
payload = {
"itemId": "<string>",
"itemAttributeInstances": [
{
"itemAttributeId": "<string>",
"value": 123
}
],
"userId": "<string>",
"userSpaceId": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
itemId: '<string>',
itemAttributeInstances: [{itemAttributeId: '<string>', value: 123}],
userId: '<string>',
userSpaceId: '<string>'
})
};
fetch('https://forgegames.org/api/item-instances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://forgegames.org/api/item-instances",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'itemId' => '<string>',
'itemAttributeInstances' => [
[
'itemAttributeId' => '<string>',
'value' => 123
]
],
'userId' => '<string>',
'userSpaceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://forgegames.org/api/item-instances"
payload := strings.NewReader("{\n \"itemId\": \"<string>\",\n \"itemAttributeInstances\": [\n {\n \"itemAttributeId\": \"<string>\",\n \"value\": 123\n }\n ],\n \"userId\": \"<string>\",\n \"userSpaceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://forgegames.org/api/item-instances")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"itemId\": \"<string>\",\n \"itemAttributeInstances\": [\n {\n \"itemAttributeId\": \"<string>\",\n \"value\": 123\n }\n ],\n \"userId\": \"<string>\",\n \"userSpaceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://forgegames.org/api/item-instances")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"itemId\": \"<string>\",\n \"itemAttributeInstances\": [\n {\n \"itemAttributeId\": \"<string>\",\n \"value\": 123\n }\n ],\n \"userId\": \"<string>\",\n \"userSpaceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"itemId": "<string>",
"teamId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
⌘I