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 [

postProcessing string

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

tags string[]
description string

Possible values: <= 3000 characters

data stringrequired
voteThresholdSettings string

Vote threshold

state schemaState (string)

Possible values: [draft, open, closed]

thumbnail string

Url for thumbnail

displayThumbnail string
approvalMethod string
type string
createdAt date-time

Time representation of schema creation

projectId projectId (string)required

Unique identifier for Project

id string

Unique identifier for Schema

categoryId string

Unique identifier for Category

displayInteractive string
name stringrequired
category object[]

Categories for schema

• ]

Example (from schema)

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

Example

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