template csv

Specify csv template

csv Specification

Parameter	Value
Type	Collection
Object Key(s)	csv-name
Collection Name	csv-list
Collection URI	/axapi/v3/template/csv
Element Name	csv
Element URI	/axapi/v3/template/csv/{csv-name}
Element Attributes	csv_attributes
Partition Visibility	shared
Schema	csv schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/template/csv	csv attributes	example close
POST /axapi/v3/template/csv/ Payload: { "csv": { "csv-name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/template/csv	csv attributes
Get Object	GET	/axapi/v3/template/csv/{csv-name}	csv attributes	example close
GET /axapi/v3/template/csv/a Reponse: { "csv": { "csv-name": "a", "delim-num": 44, "ipv6-enable": 0, "uuid": "227741ec-65ae-11f0-b71f-6fe93075fb18", "user-tag": "a", "a10-url": "/axapi/v3/template/csv/a" } }
Get List	GET	/axapi/v3/template/csv	csv-list
Modify Object	POST	/axapi/v3/template/csv/{csv-name}	csv attributes
Replace Object	PUT	/axapi/v3/template/csv/{csv-name}	csv attributes	example close
PUT /axapi/v3/template/csv/a Payload: { "csv": { "csv-name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/template/csv	csv-list
Delete Object	DELETE	/axapi/v3/template/csv/{csv-name}	csv attributes	example close
DELETE /axapi/v3/template/csv/a Reponse: { "response": { "status": "OK" } }

csv-list

csv-list is JSON List of csv attributes

csv-list : [

{ csv attributes },

{ csv attributes },

…

]

csv attributes

csv-name

Description Specify name of csv template

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

delim-char

Description enter a delimiter character, default “,”

Type: string

Format: string-rlx

Maximum Length: 1 characters

Maximum Length: 1 characters

Default: ,

Mutual Exclusion: delim-char and delim-num are mutually exclusive

delim-num

Description enter a delimiter number, default 44 (“,”)

Type: number

Range: 0-255

Default: 44

Mutual Exclusion: delim-num and delim-char are mutually exclusive

ipv6-enable

Description Support IPv6 IP ranges

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

multiple-fields

Type: List

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

multiple-fields

Specification	Value
Type	list
Block object keys

csv-type

Description ‘ip-from’: Beginning address of IP range or subnet; ‘ip-to-mask’: Ending address of IP range or Mask; ‘continent’: Continent; ‘country’: Country; ‘state’: State or province; ‘city’: City;

Type: string

Supported Values: ip-from, ip-to-mask, continent, country, state, city

field

Description Field index number (Index of Field)

Type: number

Range: 1-64