Skip to main content

Get all schemas containing category

GET 

/schemas/by/category/:categoryId

Get all schemas containing category

Request

Path Parameters

    categoryId categoryIdrequired

    The categoryId of the schema

Query Parameters

    name string

    Search for schema by name

    startDate date-time

    Search by start date

    endDate date-time

    Search by end date

    page integer

    Possible values: >= 1

    Default value: 1

    Specify the page number for pagination (default is 1).

    limit integer

    Default value: 10

    Specify the number of projects per page (default is 10, 0 gets all results).

    orderBy string

    Possible values: [createdAt, type, name, state]

    Field to order the results by (e.g., 'createdAt', 'ownerId'). Default is 'createdAt'.

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

    'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses

Schemas successfully retrieved

Schema

  • Array [

  • name schemaName (string)required

    Possible values: <= 32 characters

    Name of the schema

    createdAt date-time

    Time representation of schema creation

    state schemaState (string)

    Possible values: [draft, open, closed]

    category object[]

    Categories for schema

    projectId projectId (string)required

    Unique identifier for Project

    categoryId string

    Unique identifier for Category

    description string

    Possible values: <= 3000 characters

    displayInteractive string
    voteThresholdSettings string

    Vote threshold

    credits integer

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

    tags string[]
    postProcessing string

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

    data stringrequired
    thumbnail urinullable

    Url for schema's thumbnail

    type string
    id string

    Unique identifier for Schema

    approvalMethod string
    displayThumbnail string
  • ]

Loading...