Template details

Supported Formats

json
>>>

GET /api/project_templates/:project_template_id/details
Returns project template's details.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Examples

GET /api/project_templates/59c241d4a83dc1219d4f2931/details
401

Params

Param name Description
project_template_id
required

Project template id

Validations:

  • Must be a String
>>>

POST /api/project_templates/:project_template_id/details/multi_persist
Push multiple detail items for 1 template

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Examples

POST /api/project_templates/59c241d4a83dc1219d4f290a/details/multi_persist
{
  "template_details": [
    {
      "html_type": "h1",
      "instruction": "instruction"
    },
    {
      "html_type": "h2",
      "instruction": "instruction c",
      "detail_id": {
        "$oid": "59c241d4a83dc1219d4f290c"
      }
    },
    {
      "html_type": "h2",
      "instruction": "instruction 2"
    }
  ],
  "template_detail": {
    "template_details": [
      {
        "html_type": "h1",
        "instruction": "instruction"
      },
      {
        "html_type": "h2",
        "instruction": "instruction c",
        "detail_id": {
          "$oid": "59c241d4a83dc1219d4f290c"
        }
      },
      {
        "html_type": "h2",
        "instruction": "instruction 2"
      }
    ]
  }
}
200

Params

Param name Description
project_template_id
required

Project template id

Validations:

  • Must be a String
template_detail
optional

Project template detail parameter container.

Validations:

  • Must be an Array of nested elements
template_detail[item_id]
required

Item id

Validations:

  • Must be a String
template_detail[instruction]
optional

Instruction of detail.

Validations:

  • Must be a String
template_detail[rules]
required

Rule container

Validations:

  • Must be an Array of nested elements
template_detail[rules][type]
optional

The type of rule. Available types are: word_count,character_count,main_keyword,sub_keyword,alternative_keywords,pixel_size,list_item,negative_keywords

Validations:

  • Must be a String
template_detail[rules][parameters]
required

Rule parameter container

Validations:

  • Must be an Array of nested elements
template_detail[rules][parameters][name]
required

The name of parameter. Available parameters are: minimum,maximum,repetition,location,match,index,indexes,current,keyword,keywords,height,width,list_type,current_width,min_width,max_width,current_height,min_height,max_height

Validations:

  • Must be a String
template_detail[rules][parameters][value]
required

The value of parameter name

Validations:

  • Must be one of: String, Boolean, Integer.
template_detail[custom_attributes]
optional

custom attributes of item

Validations:

  • Must be an array of any type
item_id
required

Item id

Validations:

  • Must be a String