export-periodic¶
Put files to remote site periodically
export-periodic Specification¶
Parameter Value Type Collection Object Key(s) class-list Collection Name export-periodic-list Collection URI /axapi/v3/export-periodic Element Name export-periodic Element URI /axapi/v3/export-periodic/{class-list} Element Attributes export-periodic_attributes Partition Visibility shared Schema export-periodic schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/export-periodic | ||
Create List | POST | /axapi/v3/export-periodic | ||
Get Object | GET | /axapi/v3/export-periodic/{class-list} | ||
Get List | GET | /axapi/v3/export-periodic | ||
Modify Object | POST | /axapi/v3/export-periodic/{class-list} | ||
Replace Object | PUT | /axapi/v3/export-periodic/{class-list} | ||
Replace List | PUT | /axapi/v3/export-periodic | ||
Delete Object | DELETE | /axapi/v3/export-periodic/{class-list} |
export-periodic-list¶
export-periodic-list is JSON List of export-periodic attributes
export-periodic-list : [
]
export-periodic attributes¶
class-list
Description Class List Name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
class-list-list
Type: List
Reference Object: /axapi/v3/export-periodic/{class-list}/class-list/{class-list}
domain-list-list
Type: List
Reference Object: /axapi/v3/export-periodic/{class-list}/domain-list/{domain-list}
geo-location-list
Type: List
Reference Object: /axapi/v3/export-periodic/{class-list}/geo-location/{geo-location}
period
Description Specify the period in second
Type: number
Range: 60-31536000
remote-file
Description profile name for remote url
Type: string
Format: url
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
domain-list-list¶
Specification Value Type list Block object keys domain-list
Description Domain List File
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
period
Description Specify the period in second
Type: number
Range: 60-31536000
remote-file
Description profile name for remote url
Type: string
Format: url
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geo-location-list¶
Specification Value Type list Block object keys geo-location
Description Geo-location CSV File
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
period
Description Specify the period in second
Type: number
Range: 60-31536000
remote-file
Description profile name for remote url
Type: string
Format: url
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
class-list-list¶
Specification Value Type list Block object keys class-list
Description Class List Name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
period
Description Specify the period in second
Type: number
Range: 60-31536000
remote-file
Description profile name for remote url
Type: string
Format: url
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters