POST api/Settings/CreateActionSet
Creating an export preset
Request Information
URI Parameters
None.
Body Parameters
Export preset
ActionSetName | Description | Type | Additional information |
---|---|---|---|
Guid |
GUID |
globally unique identifier |
None. |
Name |
Name |
string |
None. |
Params |
Parameters |
ActionSetParams |
None. |
Format |
Export file format |
string |
None. |
Enabled |
Preset enabled flag |
boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "guid": "6e95a4df-7ca3-40ec-8d41-8d8f190800c6", "name": "sample string 2", "params": { "resizing": { "outputWidth": 1.1, "outputHeight": 2.1, "outputSizeInPercents": 3.1, "resizeUnit": 0, "subSampleOnly": true, "dpi": 5 }, "watermark": { "watermarkGuid": "dbcd2cf5-ec85-4a98-998b-6107fcc410c2", "embedWatermark": { "padding": "3, 5, 4, 2", "data": "QEA=", "scale": true, "opacity": 64, "position": 3 } }, "converting": { "outputFormatGuid": "f93c3998-76fc-4894-97a6-f837aa65ab23", "iccProfile": 2, "jpeG_Quality": 3 }, "metadata": { "embeddingMethod": 1, "excludeTagSpecGuids": "sample string 2", "includeSynonyms": true, "flatterKeywords": true, "getExcludeTagSpecHashes": {} } }, "format": "sample string 3", "enabled": true, "hasChanged": true, "initialParamsHashCode": 6 }
Response Information
Resource Description
Result containing a created export preset
ObjResultOfActionSetName | Description | Type | Additional information |
---|---|---|---|
Data | ActionSet |
None. |
|
Error |
Error description |
string |
None. |
Success |
Flag of successful operation |
boolean |
None. |
ErrorCode |
Error code |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "data": { "guid": "fa273355-7656-4937-be48-11d16658b51b", "name": "sample string 2", "params": { "resizing": { "outputWidth": 1.1, "outputHeight": 2.1, "outputSizeInPercents": 3.1, "resizeUnit": 0, "subSampleOnly": true, "dpi": 5 }, "watermark": { "watermarkGuid": "5b72bbb4-491a-4d89-a9d2-e20399382fc6", "embedWatermark": { "padding": "3, 5, 4, 2", "data": "QEA=", "scale": true, "opacity": 64, "position": 3 } }, "converting": { "outputFormatGuid": "a488fbec-1bcb-469d-87b7-22ab92c288c1", "iccProfile": 2, "jpeG_Quality": 3 }, "metadata": { "embeddingMethod": 1, "excludeTagSpecGuids": "sample string 2", "includeSynonyms": true, "flatterKeywords": true, "getExcludeTagSpecHashes": {} } }, "format": "sample string 3", "enabled": true, "hasChanged": true, "initialParamsHashCode": 6 }, "error": "sample string 1", "success": true, "errorCode": 3 }
Parameter Information
value
Export preset
Property | Description |
---|---|
Guid (Guid) |
GUID |
Name (String) |
Name |
Params (ActionSetParams) |
Parameters |
Format (String) |
Export file format |
Enabled (Boolean) |
Preset enabled flag |
HasChanged (Boolean) | |
InitialParamsHashCode (Int32) |