Identifier API

Create Identifier

POST /template/identifiers

Create Identifier.

Request

Parameter Name	Required	Type	Description
description	No	string	-
type	No	integer	Default:1
name	Yes	string	-
classification	No	integer	Default:1
privacy	No	integer	Default:0
rule	No	string	*
header_keywords	No	string	*
max_distance	No	integer	-
min_occurrence	No	integer	-
props	No	string	-
exclude_keywords	No	string	-

Response Examples

Success

{
  "status": "success",
  "code": 1001,
  "message": "Operation succeeded"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
1001	OK	Success	Inline

Responses Data Schema

HTTP Status Code 1001

Name	Type	Required	Restrictions	Title	description
» message	string	true	none		none
» code	integer	true	none		none

Add identifier into template

POST /template/template-mappings

Add identifier into template.

Request

Parameter Name	Required	Type	Description
template_id	Yes	integer	Template ID
identifier_ids	Yes	array	eg: [1,2,3]
status	No	string	Default:0

Response Examples

Success

{
  "status": "success",
  "code": 1001,
  "message": "Operation succeeded"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
1001	OK	Success	Inline

Responses Data Schema

HTTP Status Code 1001

Name	Type	Required	Restrictions	Title	description
» message	string	true	none		none
» code	integer	true	none		none