Get info on given schema
GET/schema/:schemaId
Get info on given schema
Request
Path Parameters
schemaId schemaIdrequired
The schemaId to grab data about
Query Parameters
includeAssets boolean
Whether to include schema assets in the response or not
matchTags boolean
Whether to get the assets that match the schema tags
Responses
- 200
- 403
- 404
- 500
- default
Schema successfully retrieved
- application/json
- Schema
- Example (from schema)
Schema
voteThresholdSettings string
Vote threshold
data stringrequired
type string
projectId projectId (string)required
Unique identifier for Project
createdAt date-time
Time representation of schema creation
description string
Possible values: <= 3000 characters
category object[]
Categories for schema
thumbnail string
Url for thumbnail
name stringrequired
state schemaState (string)
Possible values: [draft
, open
, closed
]
approvalMethod string
categoryId string
Unique identifier for Category
displayThumbnail string
displayInteractive string
id string
Unique identifier for Schema
tags string[]
{
"voteThresholdSettings": "",
"data": "{\"label\":\"facepaint\",\"children\":{\"albedo\":{\"label\":\"albedo\",...",
"type": "material",
"projectId": "p2Duhf5N6",
"createdAt": "2024-01-01T09:00:00.00Z",
"description": "This is restores is a legendary potion that restores health and speed",
"category": [
{
"C12JOqkBM": "Potion"
},
{
"C4DiVkafk": "Speed Potion"
}
],
"thumbnail": "https://file.playmakers.co/p34hfnB4f/djJryHfgW.jpg",
"name": "Wild Flower Potion",
"state": "draft",
"approvalMethod": "manual",
"categoryId": "C16w81Bvr0",
"displayThumbnail": "{\"type\":\"DisplayImagePostBlender\",\"width\":512,...",
"displayInteractive": "{\"type\":\"DisplayBabylon\",\"lighting\":\"default\",...",
"id": "s11EFBu2XW",
"tags": [
"potion",
"health",
"speed"
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Forbidden access"
}
NotFound
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "A mandatory item was not found"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Internal Server Error"
}
Unexpected error
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "An unexpected error occured"
}
Loading...