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

Schema successfully retrieved

application/json

Schema

Schema

thumbnail urinullable

Url for schema's thumbnail

voteThresholdSettings string

Vote threshold

state schemaState (string)

Possible values: [draft, open, closed]

approvalMethod string
displayInteractive string
type string
name schemaName (string)required

Possible values: <= 32 characters

Name of the schema

id string

Unique identifier for Schema

description string

Possible values: <= 3000 characters

createdAt date-time

Time representation of schema creation

projectId projectId (string)required

Unique identifier for Project

category object[]

Categories for schema

tags string[]
categoryId string

Unique identifier for Category

displayThumbnail string
postProcessing string

A json holding certain regulations for the post processing of submissions assigned to the schema

data stringrequired

Example (from schema)

{
  "thumbnail": "https://file.playmakers.co/s34hfnB4f/djJryHfgW.jpg",
  "voteThresholdSettings": "",
  "state": "draft",
  "approvalMethod": "manual",
  "displayInteractive": "{\"type\":\"DisplayBabylon\",\"lighting\":\"default\",...",
  "type": "material",
  "name": "string",
  "id": "s11EFBu2XW",
  "description": "This is restores is a legendary potion that restores health and speed",
  "createdAt": "2024-01-01T09:00:00.00Z",
  "projectId": "p2Duhf5N6",
  "category": [
    {
      "C12JOqkBM": "Potion"
    },
    {
      "C4DiVkafk": "Speed Potion"
    }
  ],
  "tags": [
    "potion",
    "health",
    "speed"
  ],
  "categoryId": "C16w81Bvr0",
  "displayThumbnail": "{\"type\":\"DisplayImagePostBlender\",\"width\":512,...",
  "postProcessing": "{\"unity\":{\"createAssetBundle\":\"true\",...",
  "data": "{\"label\":\"facepaint\",\"children\":{\"albedo\":{\"label\":\"albedo\",..."
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...