Update a schema

PUT 
/schema/:schemaId

Update a schema

Request

Path Parameters

schemaId schemaIdrequired

The schemaId to update

application/json

Body

Schema data

postProcessing stringnullable
displayThumbnail stringnullable
name schemaName (string)

Possible values: <= 32 characters

Name of the schema

state schemaState (string)

Possible values: [draft, open, closed]

data string

Possible values: >= 2 characters

categoryId stringnullable
description stringnullable

Possible values: <= 3000 characters

displayInteractive stringnullable
tags string[]nullable

Responses

200

Schema successfully updated

application/json

Schema

Schema

projectId projectId (string)required

Unique identifier for Project

displayInteractive string
categoryId string

Unique identifier for Category

id string

Unique identifier for Schema

state schemaState (string)

Possible values: [draft, open, closed]

approvalMethod string
data stringrequired
thumbnail string

Url for thumbnail

postProcessing string

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

createdAt date-time

Time representation of schema creation

name schemaName (string)required

Possible values: <= 32 characters

Name of the schema

voteThresholdSettings string

Vote threshold

type string
category object[]

Categories for schema

tags string[]
description string

Possible values: <= 3000 characters

displayThumbnail string

Example (from schema)

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

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