Syncplicity Support

Search our knowledgebase to get the help you need, today

Submit a request

Related articles
Follow

Filter by predefined groups

Summary

This filter allows groups of file types to be filtered (e.g. all Audio files - .wma, .wav, etc). The filter requires two rules attributes: a groups array and type. The type is either filter_group or group - either signify the groups filter. See the table below for all the allowable groups values.

 Attribute

Description

 groups

An array of group names including: Audio, Windows, Executables, Movies, Images, Temporary and Documents. 

The sub-table below lists the extensions included for each of these groups.

 typefilter_group or group are the only allowable values for this filter type. Both values signify the same filter.


 groups Name

File Extensions

 Audio.3gp, .act, .aiff, .aac, .alac, .amr, .atrac, .au, .awb, .dct, .dss, .dvf, .flac, .gsm, .iklax, .ivs, .m4a, .m4p, .mmf, .mp3, .mpc, .msv, .ogg, .opus, .ra, .rm, .raw, .tta, .vox, .wav, .wma, .wavpack
 Windows.lnk, .db, .sdf, .msp, .bas, .mdb, .msc, .dsb, .dbx, .mda, .nch, .wms, .tmp, .ini, .inf
 Executables.app, .apk, .bin, .bat, .exe, .com, .command, .cmd, .dll, .msi, .ps1, .job, .msp, .prg, .csh, .reg, .rgs, .vb, .vbs, .vbscript, .cpl, .jscript
 Movies.avi, .divx, .mp4, .wmd, .wmv, .ogx, .ogg, .ogv, .ogm, .qt, .mov, .moov, .hd264, .hdmov, .m2v, .m4e, .m4u, .m4v, .mkv, .mk3d, .mjpg, .mpeg, .mpeg1, .mpeg4, .mpg, .mpg2, .swf, .vid
 Images

.jpg, .jpeg, .jif, .jfif, .jp2, .jpx, .j2k, .j2c, .jpe, .png, .tif, .tiff, .tga, .bmp, .gif, .pdn, .psd, .dds, .webp, .wmf, .emf, .3fr, .ari, .arw, .bay, .crw, .cr2, .cap, .dcs, .dcr, .dng, .drf, .eip, .erf, .fff, .iiq, .k25, .kdc, .mdc, .mef, .mos, .mrw, .nef, .nrw, .obm, .orf, .pef, .ptx, .pxn, .r3d, .raf, .raw, .rwl, .rw2, .rwz, .sr2, .srf, .srw, .x3f

 Temporary*.tmp, *.temp, ~$*.docx, ~$*.xlsx, ~$*.pptx, ~$*.docm, ~$*.dotx, ~$*.dotm, ~$*.xlsm, ~$*.xltx, ~$*.xltm, ~$*.pptm
 Documents.rtf, .pdf, .docx, .docm, .dotx, .dotm, .pptx, .pptm, .potm, .potx, .ppsx, .ppsm, .xlsx, .xlsb, .xlsm, .xltx, .xltm, .doc, .xls, .ppt

REST API - Example 1

The example below excludes all Windows, executable, movie, and image files from being transferred.

POST {{url}}v1/jobs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

{
    "name":"Sample Job | Exclude Filter Groups",
    "kind": "transfer",
    "transfer": {
      "transfer_type": "copy",
      "audit_level": "trace",
      "batch_mode": "always",
      "conflict_resolution": "latest",
      "delete_propagation": "ignore_both",
      "failure_policy": "continue",
      "large_item": "skip",
      "lock_propagation": "ignore",
      "max_items_per_container": 10000,
      "performance": {
                "parallel_writes": {
                    "requested": 2
                }
      },         
      "permissions": {
            "policy": "add",
            "links": true,
            "failures": "exceptions"
      },
      "preserve_owners": true,
      "timestamps": true,
      "empty_containers": "create",
      "duplicate_names": "rename",
      "item_overwrite": "overwrite",
      "restricted_content": "convert",
      "segment_transform": true,
      "versioning": {
            "preserve": "native",
            "select": "all"
      },
         "group_map": {
         "id": "{{group_map_id}}",
         "type": "group_map"
      },
      "account_map": {
         "id": "{{account_map_id}}",
         "type": "account_map"
    },
        "filter":{
         "source":[
            {
               "action":"exclude",
               "rules":[
                  {
                     "groups": [
                        "Windows",
                        "Executables",
                        "Movies",
                        "Images"
                        ],
                     "type":"filter_group"
                  }
               ],
               "type":"filter_rule"
            }
         ],
         "destination":[
            {
               "action":"exclude",
               "rules":[
                  {
                     "type":"filter_shared"
                  }
               ],
               "type":"filter_rule"
            }
         ]
        },       
        "source": {
            "connection": { "id": "{{cloud_connection_source}}" },
            "impersonate_as": { "email": "joe@smith.com" },
            "target": {
                "path": "/sourcePath"
            }
        },
        "destination": {
            "connection": { "id": "{{cloud_connection_destination}}" },
            "impersonate_as": { "email": "joe@smith.com" },
            "target": {
                "path": "/destinationPath"
            }
        },
        "simulation_mode": false
    },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 5,
        "on_failure": 5,
        "on_execute": 25
    },
    "category": {
      "name": "Reports | Jobs with Exclude Group Filters"
    }
}
Powered by Zendesk