Update a schema

PUT 
/schema/:schemaId

Update a schema

Request

Path Parameters

schemaId schemaIdrequired

The schemaId to update

application/json

Body

Schema data

name string

Possible values: <= 32 characters

displayThumbnail stringnullable
state schemaState (string)

Possible values: [draft, open, closed]

displayInteractive stringnullable
categoryId stringnullable
data string

Possible values: >= 2 characters

description stringnullable

Possible values: <= 3000 characters

tags string[]nullable
postProcessing stringnullable

Responses

200

Schema successfully updated

application/json

Schema

Schema

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"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

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