Get all schemas containing category

GET 
/schemas/by/category/:categoryId

Get all schemas containing category

Request

Path Parameters

categoryId categoryIdrequired

The categoryId of the schema

Query Parameters

name string

Search for schema by name

startDate date-time

Search by start date

endDate date-time

Search by end date

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify the number of projects per page (default is 10, 0 gets all results).

orderBy string

Possible values: [createdAt, type, name, state]

Field to order the results by (e.g., 'createdAt', 'ownerId'). Default is 'createdAt'.

sortOrder string

Possible values: [asc, desc]

Default value: desc

'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

200

Schemas successfully retrieved

application/json

Schema

Schema

• Array [

state schemaState (string)

Possible values: [draft, open, closed]

type string
description string

Possible values: <= 3000 characters

approvalMethod string
voteThresholdSettings string

Vote threshold

tags string[]
data stringrequired
projectId projectId (string)required

Unique identifier for Project

name stringrequired
categoryId string

Unique identifier for Category

id string

Unique identifier for Schema

createdAt date-time

Time representation of schema creation

thumbnail string

Url for thumbnail

displayInteractive string
category object[]

Categories for schema

displayThumbnail string
postProcessing string

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

• ]

Example (from schema)

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

Example

[
  {
    "category": {
      "CsRabGrUR": "Fire",
      "CE2TTib4Y": "Armor",
      "CjCXz2u61": "Dragon"
    },
    "displayInteractive": "{\"type\":\"DisplayBabylon\",\"lighting\":\"default\",\"model...",
    "thumbnail": "https://file.playmakers.co/s166n8qbe/dragonscale_armor_thumbnail.jpg",
    "displayThumbnail": "{\"type\":\"DisplayImagePostBlender\",\"width\":512,\"height\":512,\"url\":\"...",
    "id": "s166n8qbe",
    "createdAt": "2024-01-11T16:00:00.00Z",
    "voteThresholdSettings": "400",
    "categoryId": "CrAR01Tz2",
    "name": "Dragonbone Armor",
    "projectId": "pyDjppkvO",
    "data": "{\"label\":\"armor\",\"children\":{\"defensePower\":{\"label\":\"defensePower\",\"value\":120",
    "tags": [
      "armor",
      "dragon",
      "protection"
    ],
    "type": "armor",
    "state": "draft",
    "approvalMethod": "manual",
    "description": "A set of armor crafted from the scales of a mighty dragon"
  },
  {
    "createdAt": "2024-01-15T13:00:00.00Z",
    "id": "s210n8qbi",
    "displayThumbnail": "{\"type\":\"DisplayImagePostBlender\",\"width\":512,\"height\":512,\"url\":\"...",
    "thumbnail": "https://file.playmakers.co/s210n8qbi/mystic_robe_thumbnail.jpg",
    "displayInteractive": "{\"type\":\"DisplayBabylon\",\"lighting\":\"default\",\"model...",
    "category": {
      "CsRabGrUR": "Flight",
      "CE2TTib4Y": "Mystery",
      "CjCXz2u61": "Outift"
    },
    "description": "A mystical robe that enhances the wearer's magical abilities",
    "approvalMethod": "automatic",
    "state": "published",
    "type": "armor",
    "tags": [
      "armor",
      "robe",
      "magic"
    ],
    "data": "{\"label\":\"armor\",\"children\":{\"defensePower\":{\"label\":\"defensePower\",\"value\":..",
    "projectId": "pyDjppkvO",
    "categoryId": "CrAR01Tz2",
    "name": "Mystic Robe",
    "voteThresholdSettings": "100"
  }
]

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...