Description

Get a private template

Request

HTTP Method: GET

Query Parameter Description
N/A  
Path Parameter Description
template-id The template id.
curl -X GET \
  https://<tenant-name>.tines.io/api/v1/admin/templates/<template-id> \
  -H 'content-type: application/json' \
  -H 'x-user-email: <email-address>' \
  -H 'x-user-token: <api-token>'

Response

A successful request will return a private template.

Field description

Parameter Description
id Template ID.
name Template name.
description Template description.
agent type Type of agent associated with the template.
agent options Agent options.
vendor Vendor name.
product Product name.

Sample response

{ 
   "id": "472463921472463921",
   "name": Extract some text,
   "description": "test",
   "agent_type": "Event Transformation",
   "agent_options": {
       "mode": "extract",
       "matchers": [
           {
               "path": "",
               "regexp": "\\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}\\b",
               "to": "email_addresses"
           },
           {
               "path": "",
               "regexp": "https?:\\/\\/[\\S]+",
               "to": "urls"
           }
       ],
       "message": "This is an optional message"
   },
   "vendor": "API",
   "product": "API"
}