Skip to main content

Update a schema

PUT 

/schema/:schemaId

Update a schema

Request

Path Parameters

    schemaId schemaIdrequired

    The schemaId to update

Body

Schema data

    categoryId stringnullable
    state schemaState (string)

    Possible values: [draft, open, closed]

    name schemaName (string)

    Possible values: <= 32 characters

    Name of the schema

    postProcessing stringnullable
    tags string[]nullable
    data string

    Possible values: >= 2 characters

    displayInteractive stringnullable
    description stringnullable

    Possible values: <= 3000 characters

    displayThumbnail stringnullable
    thumbnail urlnullable

Responses

Schema successfully updated

Schema

    postProcessing string

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

    tags string[]
    id string

    Unique identifier for Schema

    categoryId string

    Unique identifier for Category

    thumbnail urinullable

    Url for schema's thumbnail

    displayThumbnail string
    projectId projectId (string)required

    Unique identifier for Project

    displayInteractive string
    type string
    category object[]

    Categories for schema

    name schemaName (string)required

    Possible values: <= 32 characters

    Name of the schema

    approvalMethod string
    state schemaState (string)

    Possible values: [draft, open, closed]

    createdAt date-time

    Time representation of schema creation

    description string

    Possible values: <= 3000 characters

    voteThresholdSettings string

    Vote threshold

    credits integer

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

    data stringrequired
Loading...