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
displayInteractive stringnullable
state schemaState (string)

Possible values: [draft, open, closed]

data string

Possible values: >= 2 characters

tags string[]nullable
thumbnail urlnullable
description stringnullable

Possible values: <= 3000 characters

categoryId stringnullable
name schemaName (string)

Possible values: <= 32 characters

Name of the schema

displayThumbnail stringnullable

Responses

200

Schema successfully updated

application/json

Schema

Schema

displayThumbnail string
approvalMethod string
categoryId string

Unique identifier for Category

description string

Possible values: <= 3000 characters

category object[]

Categories for schema

voteThresholdSettings string

Vote threshold

tags string[]
thumbnail urinullable

Url for schema's thumbnail

data stringrequired
state schemaState (string)

Possible values: [draft, open, closed]

displayInteractive string
postProcessing string

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

type string
projectId projectId (string)required

Unique identifier for Project

id string

Unique identifier for Schema

name schemaName (string)required

Possible values: <= 32 characters

Name of the schema

credits integer

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

createdAt date-time

Time representation of schema creation

Example (from schema)

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

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