Request Parameters

Table 1 Request body parameters

Parameter

Mandatory/Optional

Parameter Type

Value

ProjectName

Mandatory

String

Project name.

TaskName

Mandatory

String

Task name.

Files

Mandatory

Array of Table 5 objects

Image list. The size of a single image cannot exceed 50 MB.

ROIs

Optional

Array of Table 2 objects

ROI list, which is used in the component error/missing/reverse scenarios.

Patterns

Optional

Array of Table 2 objects

This parameter is used to calculate the rotation offset matrix in the component error/missing/reverse scenarios.

CodeType

Mandatory

String

Image encoding format. The default format is .jpg.

ExtraParams

Optional

object

Reserved parameter.

Table 2 ROI

Parameter

Mandatory/Optional

Parameter Type

Description

X

Mandatory

Integer

Value of the X coordinate of a rectangle.

Y

Mandatory

Integer

Value of the Y coordinate of a rectangle.

Width

Mandatory

Integer

Width of a rectangle.

Height

Mandatory

Integer

Height of a rectangle.

Label

Mandatory

String

Category.