POST api/Settings/CreateActionSet
Creating an export preset
Request Information
URI Parameters
None.
Body Parameters
Export preset
ActionSet| Name | 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": "3fe631db-b9be-4b74-a3a8-59f6adb0b5b7",
"name": "sample string 2",
"params": {
"resizing": {
"outputWidth": 1.1,
"outputHeight": 2.1,
"outputSizeInPercents": 3.1,
"resizeUnit": 0,
"subSampleOnly": true,
"dpi": 5
},
"watermark": {
"watermarkGuid": "ce2860fc-e034-4d74-8900-3e681f801c7f",
"embedWatermark": {
"padding": "3, 5, 4, 2",
"data": "QEA=",
"scale": true,
"opacity": 64,
"position": 3
}
},
"converting": {
"outputFormatGuid": "2732d7b1-204d-428a-80ed-44936dcb76f1",
"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
ObjResultOfActionSet| Name | 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": "8fb782ee-1742-4737-a0eb-742e31ab4416",
"name": "sample string 2",
"params": {
"resizing": {
"outputWidth": 1.1,
"outputHeight": 2.1,
"outputSizeInPercents": 3.1,
"resizeUnit": 0,
"subSampleOnly": true,
"dpi": 5
},
"watermark": {
"watermarkGuid": "49822dc4-239c-44ef-b573-9eca02fa6194",
"embedWatermark": {
"padding": "3, 5, 4, 2",
"data": "QEA=",
"scale": true,
"opacity": 64,
"position": 3
}
},
"converting": {
"outputFormatGuid": "cca96a91-5732-4cc1-a7d2-1bdda52661c1",
"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) |