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": "4b1b19f3-2e24-4473-a029-ba141c18f01c", "name": "sample string 2", "params": { "resizing": { "outputWidth": 1.1, "outputHeight": 2.1, "outputSizeInPercents": 3.1, "resizeUnit": 0, "subSampleOnly": true, "dpi": 5 }, "watermark": { "watermarkGuid": "eae05b82-e78a-4c6c-834b-2c45da531bac", "embedWatermark": { "padding": "3, 5, 4, 2", "data": "QEA=", "scale": true, "opacity": 64, "position": 3 } }, "converting": { "outputFormatGuid": "d2ef9f70-e077-4f10-9c11-1ef25407ae9b", "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": "b7feb305-60fb-448b-b02b-639d2eb50eec", "name": "sample string 2", "params": { "resizing": { "outputWidth": 1.1, "outputHeight": 2.1, "outputSizeInPercents": 3.1, "resizeUnit": 0, "subSampleOnly": true, "dpi": 5 }, "watermark": { "watermarkGuid": "e3f616bf-7f07-4f71-98dc-174ccc397faf", "embedWatermark": { "padding": "3, 5, 4, 2", "data": "QEA=", "scale": true, "opacity": 64, "position": 3 } }, "converting": { "outputFormatGuid": "324e3696-6c34-4954-9987-1f4ee04af190", "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) |