Creating specifications

Filling in input data

Input data fields are created from the code on the Example of input data tab. Provide a detailed example to get a ready-to-use specification. For example, if you have optional fields, include them also.

{
  "question": "Do you like dogs?"
}

{
  "verdict": true
}

{
  "age": 42
}

{
    ...
    "registration_аddress": {
        "country": "Russia",
        "city": "Moscow",
        "address": "Tverskaya str, 3-53"
    }
}

{
  "images": [
    "https://cdn.stocksnap.io/img-thumbs/960w/surfer-wave_3DBOYBPB3X.jpg",
    "https://cdn.stocksnap.io/img-thumbs/960w/fisherman-silhouette_UADULRRHEK.jpg",
    "https://cdn.stocksnap.io/img-thumbs/960w/old-photo_GEQ27OWZVV.jpg"
  ]
}

By default, all the input data fields are marked as required in the specification. To make the field optional, in the data.input configuration component specify the default property.

Filling in output data

The output data fields depend on the components that use data.output and values supported by it.

Examples:

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Yes",
      "value": true
    },
    {
      "label": "No",
      "value": false
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Yes",
      "value": "true"
    },
    {
      "label": "No",
      "value": "false"
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Yes",
      "value": 1
    },
    {
      "label": "No",
      "value": 0
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Yes",
      "value": true
    },
    {
      "label": "No",
      "value": false
    }
  ],
  "data": {
    "type": "data.output",
    "path": "results.verdict"
  }
}

{
  "type": "field.radio-group",
  "options": [
    {
      "label": "Yes",
      "value": 1
    },
    {
      "label": "No",
      "value": 0
    }
  ],
  "data": {
    "type": "data.output",
    "path": "verdicts.0"
  }
}

How to edit the specification

There are two ways to edit the specification: regular mode or JSON mode. JSON mode gives you more options — you can hide input data and use regular expressions to validate output data.

Explanations for configuring fields

Parameter	Parameter in JSON	Description
Name	id	Field ID. Only Latin letters, numbers, hyphens and underscores are allowed.
Type	type	Data type: string url boolean number float file coordinates json For arrays, add the array_ prefix to the field type in JSON mode. For example: array_file.
Required	required	Whether the field must be filled when uploading the tasks for the input data. Whether the performer's response is required in the output data. By default, fields are optional — false.
Hidden	hidden	Allows you to hide data from the performer. If this is not done, performers can get the field value programmatically. You can configure this parameter in JSON mode. For example, you can hide the assigment_id identifier you will need when reviewing assignments in a separate project. By default, the field is visible — false.
Array	array_<type>	Array of objects of the same type. Used, for example, for multiple photos uploaded by a performer. In JSON mode, there is a separate data type for the array. For example: "type": "array_file".
Min size	min_size	Minimum number of items in the array.
Max size	max_size	Maximum number of items in the array.
Allowed values	allowed_values	Allowed values for string, integer, float and boolean data types.
Min length	min_length	Minimum length of the string.
Max length	max_length	Maximum length of the string.
Min value	min_value	Minimum values for float and integer numbers.
Max value	max_value	Maximum values for float and integer numbers.
Current location	current_location	Saving the performer's current coordinates (true/false). Only for the coordinates data type. Used in tasks for the mobile app. The default value is false.
Pattern	pattern	Regular expression that the string must match. You can configure this parameter in JSON mode.

Parameter	Parameter in JSON	Description
Name	id	Field ID. Only Latin letters, numbers, hyphens and underscores are allowed.
Type	type	Data type: string url boolean number float file coordinates json For arrays, add the array_ prefix to the field type in JSON mode. For example: array_file.
Required	required	Whether the field must be filled when uploading the tasks for the input data. Whether the performer's response is required in the output data. By default, fields are optional — false.
Hidden	hidden	Allows you to hide data from the performer. If this is not done, performers can get the field value programmatically. You can configure this parameter in JSON mode. For example, you can hide the assigment_id identifier you will need when reviewing assignments in a separate project. By default, the field is visible — false.
Array	array_<type>	Array of objects of the same type. Used, for example, for multiple photos uploaded by a performer. In JSON mode, there is a separate data type for the array. For example: "type": "array_file".
Min size	min_size	Minimum number of items in the array.
Max size	max_size	Maximum number of items in the array.
Allowed values	allowed_values	Allowed values for string, integer, float and boolean data types.
Min length	min_length	Minimum length of the string.
Max length	max_length	Maximum length of the string.
Min value	min_value	Minimum values for float and integer numbers.
Max value	max_value	Maximum values for float and integer numbers.
Current location	current_location	Saving the performer's current coordinates (true/false). Only for the coordinates data type. Used in tasks for the mobile app. The default value is false.
Pattern	pattern	Regular expression that the string must match. You can configure this parameter in JSON mode.

Recommendations