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 [

category object[]

Categories for schema

projectId projectId (string)required

Unique identifier for Project

categoryId string

Unique identifier for Category

id string

Unique identifier for Schema

displayInteractive string
voteThresholdSettings string

Vote threshold

approvalMethod string
tags string[]
postProcessing string

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

state schemaState (string)

Possible values: [draft, open, closed]

description string

Possible values: <= 3000 characters

data stringrequired
type string
credits integer

The amount of project credits required to create a submission for this schema

displayThumbnail string
createdAt date-time

Time representation of schema creation

thumbnail urinullable

Url for schema's thumbnail

name schemaName (string)required

Possible values: <= 32 characters

Name of the schema

• ]

Example (from schema)

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

Example

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

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