Get all schemas of projectId

GET 
/schemas/by/project/:projectId

Get all schemas of projectId

Request

Path Parameters

projectId projectIdrequired

The projectId to grab data about

Query Parameters

state string

The state of the schema

tags string[]

The tags of the schema

includeAssets boolean

Whether to include schema/project assets in the response or not

matchTags boolean

Whether to get the assets that match the schema tags

name string

Search for schema by name

type string

Search for schema by type

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

sortBy string

Possible values: [createdAt, name]

Field to order the results by (e.g., 'createdAt'). 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 [

displayThumbnail string
approvalMethod string
categoryId string

Unique identifier for Category

createdAt date-time

Time representation of schema creation

state schemaState (string)

Possible values: [draft, open, closed]

id string

Unique identifier for Schema

thumbnail string

Url for thumbnail

description string

Possible values: <= 3000 characters

displayInteractive string
projectId projectId (string)required

Unique identifier for Project

name stringrequired
postProcessing string

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

voteThresholdSettings string

Vote threshold

data stringrequired
type string
tags string[]
category object[]

Categories for schema

• ]

Example (from schema)

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

Example

[
  {
    "displayInteractive": "{\"type\":\"DisplayBabylon\",\"lighting\":\"default\",\"model...",
    "thumbnail": "https://file.playmakers.co/s166n8qbe/dragonscale_armor_thumbnail.jpg",
    "description": "A set of armor crafted from the scales of a mighty dragon",
    "name": "Dragonbone Armor",
    "projectId": "p2Duhf5N6",
    "state": "draft",
    "id": "s166n8qbe",
    "createdAt": "2024-01-11T16:00:00.00Z",
    "displayThumbnail": "{\"type\":\"DisplayImagePostBlender\",\"width\":512,\"height\":512,\"url\":\"...",
    "approvalMethod": "manual",
    "categoryId": "CrAR01Tz2",
    "category": {
      "CjCXz2u61": "Dragon",
      "CsRabGrUR": "Fire",
      "CE2TTib4Y": "Armor"
    },
    "type": "armor",
    "tags": [
      "armor",
      "dragon",
      "protection"
    ],
    "data": "{\"label\":\"armor\",\"children\":{\"defensePower\":{\"label\":\"defensePower\",\"value\":120",
    "voteThresholdSettings": ""
  },
  {
    "type": "potion",
    "tags": [
      "potion",
      "invisibility",
      "stealth"
    ],
    "category": {
      "C1cWKBh6f": "Potion",
      "C4DiVkafk": "Invisibility",
      "C12JOqkBM": "Stealth"
    },
    "voteThresholdSettings": "medium",
    "data": "{\"label\":\"potion\",\"children\":{\"invisibilityDuration\":{\"label\":\"...",
    "state": "published",
    "id": "sF0pI1Fvh",
    "description": "A potion that grants temporary invisibility, allowing the user to move undetected.",
    "thumbnail": "https://file.playmakers.co/sF0pI1Fvh/invisibility_potion_thumbnail.jpg",
    "displayInteractive": "{\"type\":\"DisplayBabylon\",\"lighting\":\"default\",\"model\":\"",
    "projectId": "p2Duhf5N6",
    "name": "Potion of Vanishing",
    "displayThumbnail": "{\"type\":\"DisplayImagePostBlender\",\"width\":512,\"height\":512,\"url\":\"...",
    "approvalMethod": "automatic",
    "categoryId": "CvyZJ15eb",
    "createdAt": "2024-01-12T17:00:00.00Z"
  }
]

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