Get all submissions of schemaId

GET 
/submissions/by/schema/:schemaId

Get all submissions of schemaId

Request

Path Parameters

schemaId schemaIdrequired

The schemaId to grab data about

Query Parameters

name string

Search for submission by name

state string

Search for submission by state

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

200

Submissions successfully retrieved

application/json

Schema

Schema

• Array [

state string

Possible values: [draft, pendingValidation]

State in which the submission is

commentCount integer

Integer representing amount of comments on submission

source string

Submission source

creatorDisplayThumbnailData string

Thumbnail data

voteCount integer

Integer representing amount of votes on submission

thumbnail string

Thumbnail image relative to the submission

postTitle string

Submission title

schemaId stringrequired

Unique identifier for Schema

computation string

Computation technique

ownerId string

Unique identifier of the owner

description string

Submission description

createdAt date-time

Submission creation time

data string

Structural data about the submission

name submissionName (string)

Possible values: <= 32 characters

Name of the submission

id string

Unique submission identifier

• ]

Example (from schema)

[
  {
    "state": "draft",
    "commentCount": 0,
    "source": "",
    "creatorDisplayThumbnailData": "",
    "voteCount": 0,
    "thumbnail": "https://file.playmakers.co/S1gf0qsVq/thumbnail.png",
    "postTitle": " Code face paint for the latest release",
    "schemaId": "s2S7KuFGc",
    "computation": "default",
    "ownerId": "ab1a4ade-6eb9-40cd-bb3e-f274af238649",
    "description": "This is a new submission for a facepaint",
    "createdAt": "2024-09-11T10:30:56.168Z",
    "data": "{\"schema\":\"facepaint\",\"children\":{\"albedo\":{\"schema\":\"albedo\",\"image\":\"https://file.playmakers.co/S1gf0qsVq/data/facepaint.png\"}}}",
    "name": "Screaming Facepaint",
    "id": "S1gf0qsVq"
  }
]

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