Get submissions by IDs

GET 
/submissions/by/ids

Get submissions by IDs

Request

Query Parameters

submissionIds string[]required

List of submission IDs

state string

State

name string

Search for submission 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, 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

List of submissions

application/json

Schema

Schema

• Array [

createdAt date-time

Submission creation time

thumbnail string

Thumbnail image relative to the submission

state string

Possible values: [draft, pendingValidation]

State in which the submission is

source string

Submission source

commentCount integer

Integer representing amount of comments on submission

id string

Unique submission identifier

name submissionName (string)

Possible values: <= 32 characters

Name of the submission

ownerId string

Unique identifier of the owner

data string

Structural data about the submission

voteCount integer

Integer representing amount of votes on submission

description string

Submission description

schemaId stringrequired

Unique identifier for Schema

postTitle string

Submission title

computation string

Computation technique

creatorDisplayThumbnailData string

Thumbnail data

• ]

Example (from schema)

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

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Bad Request"
}

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