PieceJSON Registration Error List

Contents

This section describes possible error messages you might receive when registering Pieces to the Riiiver Developer Site. For basic information on how to upload Pieces, please refer to the section on how to Register your Piece.


Errors when uploading the PieceJSON

Error messages when uploading your PieceJSON will appear in red as seen in the image below.

Refer to the below table for more information on each error and how to address it.

IssueError MessageExplanation
File FormatCannot read. Please check format.The system is expecting a JSON file but does not recognize the file you uploaded as such. Re-upload your file in JSON format or check that your JSON file source code is correct.
JSON keyRequired parameters not set. : (key name)A required key is not described in the file, or the key type is incorrect. Enter the necessary key, or change the key type.
titlePlease limit title to 30 characters or less.The title is limited to 30 characters or fewer, so please revise.
vendorIdvendorId is invalid. Please check your vendorId on My Page. If you do not have a vendorId, set "none."The vendorId in the file is not registered or otherwise invalid. Please revise in accordance with the error message.
deviceIddeviceId is invalid. Please check deviceId for your target device. If you do not specify a device, set "none."The specified deviceId is not registered or otherwise invalid.
The deviceId is assigned on the Riiiver side when a vendor creates a PieceCore utilizing the SDK.
categoryYou can specify up to two categories.You cannot mark your Piece as qualifying in more than 2 Piece categories. Please set just 1 or 2.
"categoryId" is invalid. Please refer to the following page for valid options: https://developer.riiiver.com/en/docs/references/2274/Please revise in accordance with the error message.
osTypeosType is invalid. Please specify either iOS, Android or none.Revise according to the error message.
Enter "none" if your Piece is compatible with all operating systems or if you have created a Piece using the Lambda environment.
versionVersion numbering is invalid. Please set a valid version number.Please revise version number to X.Y.Z format.
Specify a version number higher than the previous version.
sdkVersionThe sdkVersion number is invalid. Please specify a valid version number.Please revise version number to X.Y.Z format.
OAuthThe OAuth file must be a JSON file.Confirm that the extension of the OAuth file is json.
input/
output
[input/output] "type" is invalid. Please specify number, string, boolean, array, or object.Revise according to the error message. For more details, refer to Connecting Pieces: How to Put it All Together.
[input/output] "x-unit" is invalid. "x-unit" can be used only when "type" is "number".Double-check "x-unit" on your inputObject and outputObject.
(type name) requires (key) fields.Please refer to Connecting Pieces: How to Put it All Together, and check that the information required by the Piece type you created ("number"/"string"/"boolean"/"array"/"object") matches the contents of your file.
(type name) must not include (key name) fields.Please refer to Connecting Pieces: How to Put it All Together, and check that the information required by the Piece type you created ("number"/"string"/"boolean"/"array"/"object") matches the contents of your file.
If "array" is specified for "type", you must define the "items" field.For more information, refer to the "Array" section of the "Connecting Pieces" tutorial (https://developer.riiiver.com/en/docs/references/2375/#array) for Piece connection rules.
minimum < maximum is not satisfied.
minItems <= maxItems is not satisfied
[input / output] [minimum / maximum] must be between -1000000 to 1000000.
Only one key can exist under input/output properties.Objects can have multiple properties.
A number must be specified for (key name).
preferencespreferences.properties.XXX〜 cannot be updated.Please refer to PieceJSON Keys.
properties.XXX.items: "type" is invalid. Please specify number, string, boolean, array, or object.Please make sure specifications match your preference type. For details, please refer to Preferences Usage.
preferences.properties.〜must be (type name).The type of the value/parameter you set in the default field should be the same as the type set here.
preferences.properties.〜 requires a (key).Please refer to PieceJSON Keys.
preferences.properties.〜 must be 1 of the following: (key list including enum)The key/value assigned to default field does not exist in the enum list.
1 or more properties are required
minimum
maximum
multipleOf
[minimum/maximum/multipleOf] can only be used when the following conditions are satisfied.
type is "number".
x-input-type is "drumroll" or "slider".
maximummaximum can be used in one of the following cases.
case1
  type is "number".
  x-input-type is "drumroll" or "slider".
case2
  type is "string".
  x-input-type is "text" or "textarea".
proxyCoreproxyCore file name is invalid. Enter a name up to 64 characters for the file.
File names can only include English numbers and letters, hyphens, and underscores.

Piece Registration Screen Errors

If none of the above errors are present, when you click the "Confirm" button on the PieceJSON registration screen you will be able to move your Piece forward to testing; however, additional error messages may identify some further issues with the Piece , as outlined here in yellow:

To correct these errors, modify your Piece as explained here:

IssueError MessageExplanation
Icon file format※Registration of icon failed.{"code":"400-06","error":"BadRequest","message":"The image is not readable PNG file."}Please select a .png file for your icon.
Icon size※Registration of icon failed. {"code":"400-06","error":"BadRequest","message":"The dimension must be at least 512."}Please select a square-shaped image of 512 pixels or greater.
ServiceProxyCore new registration※Registration of ServiceProxyCore failed. {"message":"ZIP filename already exists."}You cannot register a file with the same name as a ServiceProxyCore that is already registered. Please change the file name and re-upload.
ServiceProxyCore editServiceProxyCore file name cannot be changed. Please reupload with the same file name.If you want to edit an existing ServiceProxyCore you have already registered, you need to use the same filename as when you registered.