Update submission

PUT 
/submission/:submissionId

Update submission

Request

Path Parameters

submissionId submissionIdrequired

The submissionId to update

application/json

Body

Submission data

postTitle string

Submission title

state string

Possible values: [draft, submitted, approved, rejected, pendingValidation]

The state of the submission.

description string

Submission description

name string

Submission name

multipart/form-data

Body

Submission data

name submissionName (string)

Possible values: <= 32 characters

Name of the submission

files binary[]

Array of files to be uploaded

postTitle string

Submission title

description string

Submission description

state string

Possible values: [draft, pendingValidation, submitted, approved, rejected]

The state of the submission.

Responses

200

Submission successfully updated

application/json

Schema

Schema

commentCount integer

Integer representing amount of comments on submission

postTitle string

Submission title

voteCount integer

Integer representing amount of votes on submission

data string

Structural data about the submission

ownerId string

Unique identifier of the owner

thumbnail string

Thumbnail image relative to the submission

schemaId stringrequired

Unique identifier for Schema

source string

Submission source

name submissionName (string)

Possible values: <= 32 characters

Name of the submission

creatorDisplayThumbnailData string

Thumbnail data

state string

Possible values: [draft, pendingValidation]

State in which the submission is

description string

Submission description

computation string

Computation technique

createdAt date-time

Submission creation time

id string

Unique submission identifier

Example (from schema)

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

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Unauthorized access"
}

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...