Skip to main content

Get info on given schema

GET 

/schema/:schemaId

Get info on given schema

Request

Path Parameters

    schemaId schemaIdrequired

    The schemaId to grab data about

Query Parameters

    includeAssets boolean

    Whether to include schema assets in the response or not

    matchTags boolean

    Whether to get the assets that match the schema tags

Responses

Schema successfully retrieved

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

Loading...