Update submission

PUT 
/submission/:submissionId

Update submission

Request

Path Parameters

submissionId submissionIdrequired

The submissionId to update

application/json

Body

Submission data

name string

Submission name

postTitle string

Submission title

state string

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

The state of the submission.

description string

Submission description

multipart/form-data

Body

Submission data

postTitle string

Submission title

name string

Submission name

files binary[]

Array of files to be uploaded

state string

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

The state of the submission.

description string

Submission description

Responses

200

Submission successfully updated

application/json

Schema

Schema

voteCount integer

Integer representing amount of votes on submission

source string

Submission source

thumbnail string

Thumbnail image relative to the submission

description string

Submission description

commentCount integer

Integer representing amount of comments on submission

id string

Unique submission identifier

data string

Structural data about the submission

state string

Possible values: [draft, pendingValidation]

State in which the submission is

schemaId stringrequired

Unique identifier for Schema

ownerId string

Unique identifier of the owner

creatorDisplayThumbnailData string

Thumbnail data

createdAt date-time

Submission creation time

postTitle string

Submission title

computation string

Computation technique

name string

Submission name

Example (from schema)

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

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