{"openapi":"3.0.0","info":{"description":"JSON API deployed on your environment.\n\n\n# errors\n\nThe API uses standard HTTP status codes to indicate the success or failure of the API call and extension of HTTP status codes to be more accurate in the error handling. \nIn case of error, the body of the response allows you to display a message to an end user, report the error to a support service, or process the error automatically in the invoking code. In some case, some technical errors will raise the structure inside de JSon global response.\n\nThe body of the response will be JSON in the following format:\n\n```\n{\n \"error\": \"404/100\",\n \"message\": \"Resource not found\",\n \"error_uri\": \"https://club-wed.wedia-group.com:443/api/rest/errors#404/100\",\n \"errorWithContact\": false,\n \"errorSupportDetails\": [\n {\n \"value\": \"Wedia support email: support@wedia-group.com.\",\n \"key\": \"WEDIA_ERROR_SUPPORT\",\n \"params\": [\n \"support@wedia-group.com\"\n ]\n }\n ],\n \"errtag\": 706\n}\n```\n\n## Properties\n\n* **error**: (string) an extended HTTP status code.This code is formed as the concatenation of the standard code and a specific code, both separated by a slash.\n\n Example: 404/100 (Resource type not found)\n \n* **message**: (string) a human readable message to show to end user\n\n Example: Resource not found.\n \n* **submessage**: (string, optional) a more specific human readable message for some errors\n\n* **errorSupportDetails**: (object) error details to allow automatic forwarding to a support email.\n \n Example :\n ```json\n [\n {\n \"value\": \"Wedia support email: support@wedia-group.com.\",\n \"key\": \"WEDIA_ERROR_SUPPORT\",\n \"params\": [\n \"support@wedia-group.com\"\n ]\n }\n ]\n ```\n\n This data will allow you to display standard localized message such as \"Send an email to \", or allow to automatically send an email with the current error datas and other circumstantial data.\n\n * **value**: string, a standard localized message provided by the server\n * **key**: string, the key used by the server to create the message (client may by example use the same key with a specific resource bundle to define a client specific message)\n * **params** array, the list of values used by the server to patch into the localized message (client may use by example these parameters to customized the message). By convention, the first one is always the support email.\n\n The localized message contains some sequences to be patched with contextual parameters (a number in braces}.\n\n* **error_uri**: (string) uri of the error documentation (if any). \n\n By example : [https://club-wed.wedia-group.com:443/api/rest/errors#404/100](https://club-wed.wedia-group.com:443/api/rest/errors#404/100)\n \n* **errorWithContact**: (boolean) if true, the message invites user to contact a support or administration department \n* **errtag**: a number to help to find the corresponding message in log (to be communicated to a competent department).\n\n[See more about error handling](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/11928057/Error+Handling)\n\n[See error documentation](https://club-wed.wedia-group.com:443/api/rest/errors)\n\n\n# filters: JSON Query syntax \n\nFor any end point that allows it, you will be able to select resources of a type via a query (See path documentation for details about parameter). \nFor end points returning several types of resources, it is possible to specify a specific request for each type. \n⚠The possibilities of queries can be restricted according to the types of resources.\n\n## General format: JSon object\n\nThe request language is based upon JSON format. Any request or sub-request is an object, or an array of object for combination operator (and, or). The object fields are either object properties to request or a combination operator (and, or).\n\nA property type field is used to compare the property with the value and is also an object. This object must have only one field (with some exceptions). The field name is corresponding to a comparison operator and its value to the value to be compared with.\n\n1. Some operators can manage:\n* void values. In this case the value will be ignored (by convention, use `null`).\n \n Example (query resources where name is empty) :\n```json\n{ \n \"name\": {\n \"empty\": null\n }\n}\n```\n* One value.\n \n Example (query resources where name is \"My object\") :\n```json\n{ \n\t\"name\": {\n\t\t\"eq\": \"My object\"\n\t}\n}\n```\n* Several values. Then, the field value will be a value table.\n\n Example (query resources where type is 1, 3 or 4) :\n```json\n{ \n\t\"type\": {\n\t\t\"in\": [1, 3, 4]\n\t}\n}\n```\n2. Except for specific cases (cf. hereafter), the comparison between several values is an OR:\n```json\n{\n\t\"status\": {\n\t\t\"eq\": [4,5,7]\n\t}\n}\n```\nis equivalent to\n```json\n{\n\t\"or\": [\n\t\t\t{\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"eq\": 4\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"eq\": 5\n\t\t\t\t}\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"status\": {\n\t\t\t\t\t\"eq\": 7\n\t\t\t\t}\n\t\t\t}\n \t]\n}\n```\n\n \n\n3. Logical operators\n\n* OR\n\n* AND\n\n* NOT\n\nA combination type operator field type is a table with sub requests, hence an object. Then if an object property bears the same name as a combination operator, you just need to indicate an object as the field value instead of a table.\n* `{\"and\": []}` is a logical AND\n* `{\"and\": {}}` is comparison of property named \"and\"\n\nFor NOT operator, the table expression items are combined with the operator OR.\n\n```json\n{\n \"not\": [\n {\"status\":\"6\"},\n {\"activated\":true}\n ]\n}\n```\nis equivalent to\n```json\n{\n \"not\": [\n {\n \"or\":[\n {\"status\":\"6\"},\n {\"activated\":true}\n ]\n }\n ]\n}\n```\nIf the table is doubled, expression items are combined with the operator AND.\n```json\n{\n \"not\": [[\n {\"status\":\"6\"},\n {\"activated\":true}\n ]]\n}\n```\nis equivalent to\n```json\n{\n \"not\": [\n {\n \"and\":[\n {\"status\":\"6\"},\n {\"activated\":true}\n ]\n }\n ]\n}\n```\n4. The root object request creates a mandatory AND between all sub-queries.\n```json\n{\n\t\"name\": {\n\t\t\"sw\": \"A\"\n\t},\n\t\"status\": {\n\t\t\"gte\": 3\n\t}\n}\n```\nis equivalent to\n```json\n{\n\t\"and\":[ \n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"sw\": \"A\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"status\": {\n\t\t\t\t\"gte\": 3\n\t\t\t}\n\t\t}\n\t]\n}\n```\n5. It is also possible to combine several comparisons on a single field in one clause AND:\n```json\n{\n\t\"date\": {\n\t\t\"gte\": \"now\",\n\t\t\"lt\": \"now(1)\"\n\t}\n}\n```\nis equivalent to\n```json\n{\n\t\"and\":[\n\t\t{\n\t\t\t\"date\": {\n\t\t\t\t\"gte\":\"now\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"date\": {\n\t\t\t\t\"lt\": \"now(1)\"\n\t\t\t}\n\t\t}\n\t]\n}\n```\n\n\n## Operators\n\nOperators are not case sensitive. All operators are available in short or long version.\n\n| Long | Short | Definition |\n| --- | --- | --- |\n| equals | eq | Equals to |\n| notequals | neq | Not equals to |\n| greaterthan | gt | Greater than |\n| greaterorequals | gte | Greater than or equals to |\n| lesserthan | lt | Lesser than |\n| lesserthanorequals | lte | Lesser than or equals to |\n| empty | e | Void or null |\n| notempty | ne | Non void and not null |\n| in | in | Belongs to |\n| notin | nin | Does not belong to |\n| startswith | sw | Starts with |\n| notstartswith | nsw | Does not starts with |\n| endswith | ew | Ends with |\n| notendswith | new | Does not ends with |\n| contains | ct | Contains |\n| notcontains | nct | Does not contains |\n| descendantof | dof | Descendant of | \n| notdescendantof | ndof | Not descendant of | \n| overlap | ovrl | Overlapping of two ranges | \n\nOperators can use any type. The type value is adapted depending on the context. \nE.g. all following expressions are equivalent:\n```json\n{\n \"activated\": {\n \"eq\": true\n }\n}\n```\n```json\n{\n \"activated\": {\n \"eq\": \"true\"\n }\n}\n```\n```json\n{\n \"activated\": {\n \"eq\": \"1\"\n }\n}\n```\n```json\n{\n \"activated\": {\n \"eq\": 1\n }\n}\n```\nIf the operator equals is used with value null, the operator used is empty. If the operator notequals is used with value null, the operator used is notempty.\n\n### Operators for the text data type\n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n| startswith | sw | Starts with | yes |\n| notstartswith | nsw | Does not starts with | yes |\n| endswith | ew | Ends with | yes |\n| notendswith | new | Does not ends with | yes |\n| contains | ct | Contains | yes |\n| notcontains | nct | Does not contain | yes |\n \n### Operators for the number data type\n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| greaterthan | gt | Greater than | yes |\n| greaterorequals | gte | Greater than or equals to | yes |\n| lesserthan | lt | Lesser than | yes |\n| lesserthanorequals | lte | Lesser than or equals to | yes |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n\n### Operators for the boolean data type\n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n\n### Operators for the timestamp (or date) data type\nThe value is automatically converted to the appropriate type according to the type of the compared field (date or datetime). \n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| greaterthan | gt | Greater than | yes |\n| greaterorequals | gte | Greater than or equals to | yes |\n| lesserthan | lt | Lesser than | yes |\n| lesserthanorequals | lte | Lesser than or equals to | yes |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n\n#### Value and format\nThe dates comparison values could be set in JavaScript timestamp (as long) or using simple ISO strings.\n```json\n{\n \"datetime\": {\n \"eq\": 1552405738000\n }\n}\n```\n```json\n{\n \"date\": {\n \"eq\": \"20160308\"\n }\n}\n```\n```json\n{\n \"datetime\": {\n \"eq\": \"20160308T124223\"\n }\n}\n```\n#### Functions\n* Function `now` allows to compare to now or relative dates. Specify the difference in days between brackets (negative numbers for earlier dates and positive numbers for later dates):\n * `new` or `new(0)`means *today* (or *now* for datetime);\n * `new(-1)` means *yesterday*;\n * `new(1)` or `new(+1)` means *tomorrow*.\n```json\n{\n\t\t\"date\": {\n\t\t\t\"eq\": \"now(-10)\"\n\t\t}\n}\n```\n```json\n{\n\t\t\"datetime\": {\n\t\t\t\"gt\": \"now\"\n\t\t}\n}\n```\n* Function `ts` allows to compare to a timestamp within a string context (like request parameter) \nBy example: `ts(1552405738000)`.\n\n### Operators for the path (resource file/image) data type\nPath for resources can use slash (/) or backslash (\\) indifferently.\n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n| startswith | sw | Starts with | yes |\n| notstartswith | nsw | Does not starts with | yes |\n| endswith | ew | Ends with | yes |\n| notendswith | new | Does not ends with | yes |\n| contains | ct | Contains | yes |\n| notcontains | nct | Does not contains | yes |\n\n### Operators for the object data type\nThe test value shall be an object identifier or void for empty or not empty. Except for subqueries (see below). \n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n| in | in | Belongs to | yes |\n| notin | nin | Does not belong to | yes |\n| descendantof | dof | Descendant of | yes |\n| notdescendantof | ndof | Not descendant of | yes |\n\n### Operators for the array data type\n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n| in | in | Belongs to | yes |\n| notin | nin | Does not belong to | yes |\n| contains | ct | Contains | yes |\n| notcontains | nct | Does not contains | yes |\n| descendantof | dof | Descendant of | yes |\n| notdescendantof | ndof | Not descendant of | yes |\n\n### Operators for the identity data type\n\n| Long | Short | Definition | Multivalued |\n| --- | --- | --- | --- |\n| equals | eq | Equals to | yes |\n| notequals | neq | Not equals to | yes |\n| greaterthan | gt | Greater than | no |\n| greaterorequals | gte | Greater than or equals to | no |\n| lesserthan | lt | Lesser than | no |\n| lesserthanorequals | lte | Lesser than or equals to | no |\n| empty | e | Void or null | no |\n| notempty | ne | Non void and not null | no |\n| in | in | Belongs to | yes |\n| notin | nin | Does not belong to | yes |\n\n### Subqueries\nFor types object and array, it is possible to use subquery instead of id. The subquery must return none or one object.\nBy example, to look for object with product having code equal to \"CD001\" :\n```json\n{\n \"product\":{\n \"code\":\"CD001\"\n }\n}\n```\nFor multiple object field, use contains operator.\n\nBy example, to look for objects with product having ean equal to \"3276000338345\" :\n```json\n{\n \"pimproducts\": {\n \"ct\": \n {\n \"ean\" : \"3276000338345\"\n } \n }\n}\n```\n### Query workflows\n\nYou can directly query a workflow.\n\nBy example : \n```json\n{\n \"status\": { \"eq\": \"draft\" }\n}\n```\n\n### Overlap operator\nIt is easy to test range overlap with the `overlap` operator (or in short version, `ovrl`). This operator works for date or number ranges.\n\nThe syntax is\n```json\n{\n \"overlap\": [\n { \n \"rangestartproperty\" : \n { \n \"gt\": rangestartvalue \n } \n },\n { \n \"rangeendproperty\" : \n { \n \"lt\": rangeendvalue \n } \n }\n ]\n}\n```\nrangestartproperty and rangeendproperty are respectively the names of the properties that store the lower and higher edges of the range. rangestartvalue and rangeendvalue are respectively the values of the lower and higher edges of the range to compare to the stored range. \nThe operators can be stricly greater or lower to exclude edges or not to include edges (use gte instead of gt, and lte instead of lt). Null or empty values are excluded automatically.\n\nExample for a date range :\n```json\n{\n \"overlap\": [\n { \n \"startdate\" : {\n \"gte\": \"now(-10)\" \n }\n },\n { \n \"enddate\" : {\n \"lt\": \"now\" \n } \n }\n ]\n}\n```\n### Similar images\n\nThe similarimage operator (or sim in its short version) is used to search for assets that have a similar image (hash comparison algorithm).\n\nExample (searches for assets whose image is similar to the images of assets 1 or 2) : \n```json\n{\n \"similarimage\": [ \"1\", \"2\" ]\n}\n```\nExample (searches for assets whose image is similar to the images of legacy assets 1 or 2) : \n```json\n{\n \"similarimage\": [ {\"resource\":\"legacy\",\"id:\"1\"}, {\"resource\":\"legacy\",\"id:\"2\"} ]\n}\n```\n## Non static values\n\n### Variables\n\nIn some contexts, it is possible to have parts configurable by variables. The variables and their reference depends on the context. Only the value part can be set (neither the operator nor the field name can be set). \nThe common syntax is \\${<variable identifier>}. There is always a default context and other contexts. Usually, the identifier for a variable of the common context is its name. For variables in a context other than the default one, use a prefix of the type :.\n\n* By example, `${name}` is the value of the property name. \n* By example, `${par:actionname}` is the request parameter actionname.\n\n### Surfer properties\n\nIn all authenticated context, it is possible to refer to *surfer* (user who invokes the end point) property values. Use the variable syntax pattern with the prefix surfer. By example, \\${surfer.id} refer to the surfer id. To get a custom property, use \\${surfer.props.}.\n\nExample:\n```json\n{\n \"pimproducts\": { \n \"in\": \"${surfer.props.userpimproducts}\"\n }\n}\n```\nwith\n```java\n{\n surfer.setProperty(\"userpimproducts\",\"1,2,3\");\n}\n```\nwill be resolved towards\n```SQL\npimproducts in ('1','2','3')\n```\nProperties currently available:\n\n| Variable pattern | Definition |\n| --- | --- |\n| \\${surfer.id} | Surfer/user id |\n| \\${surfer.name} | Surfer/user name |\n| \\${surfer.role} | Surfer/user role name |\n| \\${surfer.role.id} | Surfer/user role id |\n| \\${surfer.locale} | Surfer/user locale |\n| \\${surfer.localejs} | Surfer/user locale (html/js syntax) |\n| \\${surfer.login} | Surfer/user login |\n| \\${surfer.props.<name>} | Surfer/user property named *name* |\n\n## policies\n\nThe configuration of a resource may rely to policies that prohibited some field to be used in a query. \n\n\n# general parameters\n\n## Parameters common to all end points\n\nThese parameters can be used with any end point URIs:\n\n* `lang`\n\n This parameter is used to override default preferences (user, browser…) localization language, set with header `Accept-Language`.\n\n By example: `lang=en-US`\n\n* `state`\n\n The value of this parameter is returned as it is in the response. When the value is JSON, it is directly integrated into the JSON response structure. This information allows you to reconcile a response and a request. This is particularly useful if the client uses an asynchronous and centralized queue. Another case could be the possibility of ignoring obsolete responses. For example, in a search system, an impatient user could restart a new search and his answer could come back before the answer of the previous search. The state will let you know that the second answer is obsolete and no longer needs to be processed. \n To limit the load on response times, prefer to send an identifier (or short data structure) and manage an association map in the client to find the information that allows you to find the request (or the component that is supposed to process the response).\n\n By example: `state=searchquery#a1fe37`\n \n## Localization\n\nBy default, the localization is based upon the web browser language locale. If the web browser has no locale, it uses header Accept-Language.\nIt is also possible to force a locale by using the request parameter lang. Its syntax is similar to the header. \nIf the requested language is not supported the service will respond NOT_ACCEPTABLE.\n\n## HTTP methods\n\nIn some cases (particularly when the server is not configured to do so), it is not possible to use methods other than GET, HEAD or POST.\nThen we could override the method. The end point should be called with the POST method and the name of the actual method should be set in a specific header.\nThe supported standard headers for method overriding are:\n\n* X-HTTP-Method-Override (Google/GData HTTP method overwriting)\n\n* X-HTTP-Method (Microsoft HTTP method overwriting)\n\n* X-METHOD-OVERRIDE (IBM HTTP method overwriting)\n\n\n# image transform\n\nThe imaging API will allow you to transform images while downloading them. The value of the parameter `transform` is a command set: this is the list of commands and their parameters to be chained to obtain the final image.\n\nExamples:\n\n* Example 1 - Cropping\n```HTML \nx_80,y_80,w_135,h_65,c_crop\n```\n| Input: Boat in clear blue ocean, W400×H267 | Output: Boat in clear blue ocean, W135×H65 |\n|:------:|:------:|\n|![Boat in clear blue ocean: W400×H267](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean.jpg)|![Boat in clear blue ocean: W135×H65](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean_jpg_'x_80,y_80,w_135,h_65,c_crop'.jpg)\n\n* Example 2 - Liquid resizing \n```HTML \n w_proportional,h_50p,c_lresize\n```\n| Input: Madivaru finolhu, Maldives, W320×H400 | Output: Madivaru finolhu, Maldives, W160×H200 | To compare to resize output `w_proportional,h_50p,c_resize` |\n|:------:|:------:|:------:|\n|![Madivaru finolhu, Maldives: W320×H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island.jpg)|![Madivaru finolhu, Maldives: W160×H200](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_lresize'.jpg)|![Madivaru finolhu, Maldives: W160×H200 (resized)](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_resize'.jpg)|\n\n⚠The possibilities of imaging can be restricted according to imaging policies and the types of resources.\n\n[Find out more on Imaging REST API](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations#commands)\n\n## Command set\n\nThe command set is defined by a comma separated list of parameters and commands. Spaces are not allowed except in the texts, between double-quotes (see below).\n\n### parameter or command\n\nA parameter is a prefix (one or two letters) followed by an underscore then by a value. \nThe prefix defines the type of value:\n* `c` for a command name\n* other (see below) for a parameter (`w` by example for width)\n\n### switches \n\nThis is a boolean parameter, can be set (enabled) or unset (disabled). This is a name without underscore and prefixed with `+` or `-` (default if not prefixed is `+`).\n\nBy example: `+fixed`\n\n### command set\n\nEach command is preceded by its parameters.\n\n* Example (resize image to 100×100 pixels)\n```HTML\nw_100,h_100,c_resize\n\nSeveral commands can be linked in succession. Each command processes the result of the previous command.\n\n* Example (resize image to 100×100 pixels, then add a border around the new image)\n```HTML\nw_100,h_100,c_resize,bd_40,bg_sandybrown,c_pad\n```\n\n## Values\n\nThe syntax for the values follows the following rules:\n\n* dimension value \n\n Defines a dimension (x, y, width, height, top, right, bottom or left) in pixels. It could be absolute or relative to the size of the image.\n \n * a positive number means an absolute size in pixels\n ```HTML\n w_100,h_100\n ```\n * a positive number followed by px means an absolute size in pixels\n ```HTML\n w_100px,h_100px\n ```\n * a positive number followed by `f` (or `×`) means a factor\n ```HTML \n w_2f,h_0.5×\n ```\n means double width and halved height \n * a number followed by `p` (or `%`) means a percentage\n ```HTML \n w_200p,h_50%\n ```\n * the word `proportional` could be used as value in some commands (you can use also the number `-1`) \n \n* size value\n\n Defines a dimension in different units. The same values as used for dimension value could be used, and the followed additional syntaxes:\n\n * a number followed by mm means a size in millimeters.\n ```HTML \n w_50mm\n ```\n * a number followed by a quote means a size in inches.\n ```HTML \n w_50'\n ```\n * a number followed by `pt` means a size in points.\n ```HTML \n w_72pt\n ```\n \n* factor value\n\n * a positive number means a factor: the final size will be the original size multiplied by the factor\n ```HTML \n w_2,h_0.5\n ```\n means doubled width and halved height.\n\n * a number followed by `f` (or `×`) means a factor \n ```HTML \n w_2f,h_0.5×\n ```\n means doubled width and halved height.\n \n * a number followed by `p` (or `%`) means a percentage\n ```HTML \n w_200p,h_50%\n ```\n* angle value\n\n Defines an angle value, in degrees by default.\n \n * a number means a value in degrees \n ```HTML \n a_-45,c_rotate\n ```\n * a number followed by `°` or `deg` means an angle in degrees\n ```HTML \n a_-45°,c_rotate\n ```\n ```HTML \n a_-45deg,c_rotate\n ```\n * a number followed by `rad` means an angle in radians \n ```HTML \n a_3.14rad,c_rotate\n ```\n * a number followed by `pi`, (or `%` or `π`) means pi multiplied by the value \n ```HTML \n a_1.5pi,c_rotate\n ```\n means 3∕2 × π\n * an integer followed by `>`, (or `right`) means a clockwise 90 degrees rotation (number 1 may be omitted)\n ```HTML \n a_2>,c_rotate\n ```\n ```HTML \n a_right,c_rotate\n ```\n * an integer followed by `<`, (or `left`) means a counterclockwise 90 degrees rotation (number 1 may be omitted) \n ```HTML \n a_<,c_rotate\n ```\n ```HTML \n a_2left,c_rotate\n ```\n* color value\n\n * html color name\n ```HTML \n bg_red\n ```\n * gray level\n ```HTML \n bg_gray50\n ```\n * hexadecimal RGB code\n ```HTML \n bg_#FF0000\n ```\n * transparent color\n ```HTML \n bg_none\n ```\n * a string starting with $dom to specify the dominant color of the image. It can be followed with the index of the dominant color.\n \n * $dom means the first dominant color\n * $dom2 means the second dominant color\n * $dom2-1 means the second dominant color, skipping the first one\n \n ```HTML \n bg_$dom\n ```\n \n * a string starting with $gradient:, followed with the starting and the ending colors, separated by a dash, to specified a vertical gradient.\n \n ```HTML \n bg_$gradient:red-blue\n ```\n \n * You can specify an extent with a dimension value:\n ```HTML \n fg_$gradient:red-blue-50%\n ```\n * No color value means none:\n ```HTML \n fg_$gradient:red\n ```\n is equivalent to \n ```HTML \n fg_$gradient:red-none\n ```\n * a string starting with $pattern:, followed with the name of a pattern, to specified a pattern. \n ```HTML \n bg_pattern:checkerboard\n ```\n * the string $blur, or a string starting with $blur: followed with blur parameters, to specify a blur of the background image.\n \n * blur parameters: It’s two positive integers separated with an x. The first is radius and the second sigma.\n ```HTML \n bg_$blur:25x25\n ```\n * `$blur` is equivalent to `$blur:3x3`\n \n* density value\n\n Define the density in dpi (Dot Per Inches).\n \n * a positive number means an absolute size in pixels\n ```HTML\n hv_72,vv_72\n ```\n \n* font description\n\n Selects a font (the font must be installed in the server), with a font name , a font size (cf \"size value\"), font styles (bold, italic…).\n\n * a string, with component separated with a pipe\n ```HTML \n f_Arial\n ``` \n ```HTML \n f_Arial|16pt\n ```\n ```HTML \n f_Candice|20%|bold\n ```\n ```HTML \n f_Candice|bold|italic\n ```\n * a number, as size in point \n ```HTML \n f_24\n ``` \n * Font styles are a combination of different parameters:\n * style:\n * Italic\n * Oblique\n * weight:\n * Thin\n * ExtraLight\n * Light\n * Medium\n * DemiBold \n * Bold\n * ExtraBold\n * Heavy\n * stretch:\n * Condensed\n * Expanded\n * ExtraCondensed\n * ExtraExpanded\n * SemiCondensed\n * UltraCondenses\n * UltraExpanded \n \n * Text decoration parameter \n \n Specifies a text decoration, one of these values:\n\n * None\n * Underline\n * LineThrough\n * Overline\n \n* gravity value \n\n Specifies a location in the image, like in this grid:\n \n\n\n\n
northwestnorthnortheast
westcentereast
southwestsouthsoutheast
\n\n Gravity often can be mixed with a location by coordinates (x and y):\n\n * if both coordinates are provided, gravity value is ignored\n * if only one of the two is provided, gravity is used to locate on other axis\n \n* preset name\n\n Specifies the name of a preset\n \n ```HTML \n n_circle_png\n ``` \n \n* shade parameter\n\n It’s two positive integers (angles in degrees) separated with an x. The first is direction and the second elevation, of a light source.\n\n ```HTML \n sh_45x90\n ```\n \n* string value\n\n A simple text or word\n \n ```HTML \n tx_hello!\n ```\n\n * Simple text (without spaces or special characters)\n```HTML\ntx_hello\n```\n * To specify text with spaces, or other special characters, embrace it between double-quotes\n```HTML\ntx_\"hello you!\"\n```\n * You can put double-quotes within text by duplicate them (escape double-quotes) \n```HTML\ntx_\"say \"\"hello\"\"!\"`\n```\n * Use antislash \\ to escape special characters, like \\n for carriage return. Use two of them to get an antislash: \\\\n means exactly \\n, not carriage return.\n```HTML\ntx_\"First line\\nSecond line with \\\\n\"\n```\nto get\n>```HTML\n>first line\n>second line with \\n\n>```\n * You can use \\u followed by unicode codepoint (four hexadecimal digits mandatory) to specify special characters\n```HTML\ntx_\"\\u00a9xxx\"\n```\nto get `©xxx`.\n\n## Commands\n\n### autoorient\n\nResets EXIF image profile setting 'Orientation' and then performs the appropriate 90 degree rotation on the image to orient the image, for correct viewing.\n\nNo parameters.\n\nExample:\n\n```HTML \nc_autoorient\n``` \n### background\n\nFills the transparent background of the image with the specified color.\n\nParameters:\n\n* prefix `bg`: a **color value**, default value is `none`. \n \n Specifies the background filling color. *Blur* type color is not allowed in this context.\n \nExamples: \n* Example 1 - Fill background with a color\n```HTML \nbg_dodgerblue,c_background\n``` \n* Example 2 - Fill background with a pattern\n```HTML \nbg_$pattern:checkerboard,c_background\n``` \n* Example 3 - Fill background with a gradient\n```HTML \nbg_$gradient:-aquamarine,c_background\n```\n* Example 4 - Fill background with a sized gradient\n```HTML \nbg_$gradient:dodgerblue-aquamarine-80p,c_background \n``` \n\n### clip\n\nFills with a color the area delimited by a clipping path contained in the image\n\nParameters:\n\n* prefix `bg`: a **color value**, default value is `none`. \n \n Specifies the background filling color.\n \n* prefix `cp`: a path name, or an index (# followed by the position from 1 to n), default is `#1` \n \n Specifies the clipping path to use \n \n* switch `outside`: to choose whether to fill the inside or the outside of the path, default is true (ie outside)\n \n* prefix `cl`: a colorization factor\n\n specifies the percentage by which the fill color is blended with the background\n\nExamples: \n* Example 1 - Clip and fill with a color\n```HTML \nbg_dodgerblue,c_clip\n``` \n| Input: Flamingo, W2983×H3977 | Output: Flamingo, W2983×H3977 |\n|:------:|:------:|\n|![Flamingo: W2983×H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo.jpg)|![Flamingo: W2983×H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo_jpg_'bg_dodgerblue,c_clip'.jpg)\n\n* Example 2 - Clip along a named clipping path\n```HTML \nbg_$gradient:DarkBlue-Turquoise,n_Flamingo,c_clip\n```\n| Input: Flamingo, W2983×H3977 | Output: Flamingo, W2983×H3977 |\n|:------:|:------:|\n|![Flamingo: W2983×H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo.jpg)|![Flamingo: W2983×H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo_jpg_'bg_$gradient_DarkBlue-Turquoise,n_Flamingo,c_clip'.jpg)\n\n* Example 3 - Clip with half blending\n```HTML \nbg_red,cl_50,c_clip\n```\n| Input: Flamingo, W2983×H3977 | Output: Flamingo, W2983×H3977 |\n|:------:|:------:|\n|![Flamingo: W2983×H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo.jpg)|![Flamingo: W2983×H3977](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/flamingo_jpg_'bg_red,cl_50,c_clip'.jpg)\n\n### crop\n\nCrop a subimage from the image, and optionally layout the subimage into the crop box. The coordinates of the cropping box can be absolute or relative to the image, in location, as well as in size, and can be specified as Cartesian absolute coordinates or CSS relative position (top, right, bottom, left), but not at the same time. \n\nParameters:\n\n* Cartesian coordinates\n\n Default mode.\n\n * prefix `x`: a **dimension value**, default value is 0 \n\n The x (easting) of the top-left corner of the cropping box \n \n * prefix `y`: a **dimension value**, default value is 0\n\n The y (northing) of the top-left corner of the cropping box\n \n * prefix `w`: a **dimension value**, default value is 100%\n\n The width of the cropping box\n\n * prefix `h`: a **dimension value**, default value is 100%\n\n the width of the cropping box\n \n* CSS top, right, bottom, left\n\n Coordinates not mentioned are deducted from the values mentioned. If none of them are, you have to switch to Cartesian mode. \n If only one of them is mentioned, all have the same value. If two of them are, the others are deducted first in relation to their axis (vertical or horizontal).\n \n * prefix `t`: a **dimension value**\n \n the top inset \n \n * prefix `r`: a **dimension value**\n \n the right inset \n \n * prefix `b`: a **dimension value**\n \n the bottom inset \n \n * prefix `l`: a **dimension value**\n \n the left inset \n \n* switch `centered`: to set or not the centered mode (not set by default)\n \n If set, moves the bounding box top left corner coordinates (x and y) to center of bounding box. This moves the reference for Cartesian coordinates. \n \n* switch `fixed`: to set or not the fixed mode (not set by default)\n \n In this mode, the resulting image always has the size of the cropping box, or the fixed size bounding box, if specified\n \n * prefix `fw`: a **dimension value**\n \n width of the fixed size bounding box\n \n * prefix `fh`: a **dimension value**\n \n height of the fixed size bounding box\n \n * prefix `ly` layout type (location of the cropped image into the result image, in case of overflowing cropping). Default is **none**.\n \n * **none**: no layout;\n * **center**: the resulting image is centered in the cropping box;\n * **tile**: the resulting image is a tile (the image is cut into tiles according to a regular grid) \n * **fit**: the resulting image fits the cropping box\n * **fill**: the resulting image fills the cropping box\n * **lresize**: the resulting image fills the cropping box with seam carving algorithm \n \n If only one of `fw` or `fh` only is set, both will have the same value.\n\n\nExamples: \n* Example 1 - Simple border cropping (Removes 20% around the image)\n```HTML \nt_20p,c_crop\n``` \n| Input: Maldives, W400×H225 | Output: Maldives, W320×H180 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W320×H180](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'t_20p,c_crop'.jpg)\n\n* Example 2 - Box cropping\n```HTML \nx_80,y_80,w_135,h_65,c_crop\n```\n| Input: Boat in clear blue ocean, W400×H267 | Output: Boat in clear blue ocean, W135×H65 |\n|:------:|:------:|\n|![Boat in clear blue ocean: W400×H267](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean.jpg)|![Boat in clear blue ocean: W135×H65](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/boat-in-clear-blue-ocean_jpg_'x_80,y_80,w_135,h_65,c_crop'.jpg)\n\n* Example 3 - Focus crop, no layout, no fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,c_crop\n```\n| Input: Iceland, W300×H409 | Output: Iceland, W200×H150|\n|:------:|:------:|\n|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200×H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,c_crop'.jpg)\n\n* Example 4 - Focus crop, no layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,c_crop\n```\n| Input: Iceland, W300×H409 | Output: Iceland, W100×H75|\n|:------:|:------:|\n|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W100×H75](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,c_crop'.jpg)\n\n* Example 5 - Focus crop, tile layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop\n```\n| Input: Iceland, W300×H409 | Output: Iceland, W200×H150|\n|:------:|:------:|\n|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200×H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop'.jpg)\n \n >💡 To get a transparent background, instead of black, convert the image to png. To get a background in the color you want, then use the background command. Then you can transform back the image to the original format.\n>```HTML \n>e_png,c_format,x_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop,bg_lavender,c_background,e_$org,c_format\n>```\n>| Input: Iceland, W300×H409 | Output: Iceland, W200×H150|\n>|:------:|:------:|\n>|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200×H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'e_png,c_format,x_0,y_0,w_200,h_150,centered,fixed,ly_tile,c_crop,bg_lavender,c_background,e_$org,c_format'.jpg)\n \n* Example 6 - Focus crop, center layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_center,c_crop\n```\n| Input: Iceland, W300×H409 | Output: Iceland, W200×H150|\n|:------:|:------:|\n|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200×H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_center,c_crop'.jpg)\n \n* Example 7 - Focus crop, fit layout, fixed size\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_fit,c_crop\n```\n| Input: Iceland, W300×H409 | Output: Iceland, W200×H150|\n|:------:|:------:|\n|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200×H150](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_fit,c_crop'.jpg)\n \n* Example 8 - Focus crop, fill layout, changing bounds\n```HTML \nx_0,y_0,w_200,h_150,centered,fixed,ly_fill,fw_200,fh_200,c_crop\n```\n| Input: Iceland, W300×H409 | Output: Iceland, W200×H200|\n|:------:|:------:|\n|![Iceland: W300×H409](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland.jpg)|![Iceland: W200×H200](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/iceland_jpg_'x_0,y_0,w_200,h_150,centered,fixed,ly_fill,fw_200,fh_200,c_crop'.jpg)\n\n### density\n\nSpecifies the image resolution. Sets an attribute and does not alter the underlying raster image.\n\nParameters:\n\n* prefix `d`: the value of density, as pixels per unit, or a couple of values separated by ×, one for horizontal value, the other for vertical value; \n* prefix `hv`: the horizontal density value, as pixels per unit;\n* prefix `hh`: the vertical density value, as pixels per unit;\n* switch `ppc`: to set the unit to centimenter (by default, unit is inch)\n* prefix `q`: the quality of file for type which handle it (jpeg, mpeg, png, mng, tiff, miff, bpg, webp…​). It’s a positive integer, usually from 0 (or 1) to 100, the lowest means the lowest quality, the highest means highest quality. \n\nExamples: \n* Example 1 - Set to 300dpi\n```HTML \nd_300,c_density\n```\n* Example 2 - Set to 256×192dpc\n```HTML \nd_256×192,ppc,c_density\n```\nor\n```HTML \nvh_256,vv_192,ppc,c_density\n```\n\n\n### fill\n\nAdapts the size of the image to completely fill a box, parts of the image can therefore be hidden, but proportionality is respected.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n width of the new image\n \n* prefix `h`: a **dimension value**, default value is 100%\n\n height of the new image\n \n* prefix `g`: a **gravity value**\n* prefix `x`: a **dimension value**, default value is 0\n\n the x (easting) of the center point of the source image in the target image\n \n* prefix `y`: a **dimension value**, default value is 0\n\n the y (northing) of the center point of the source image in the target image\n\nExamples: \n* Example 1 - Fill, no gravity\n```HTML \nw_300,h_300,c_fill\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W300×H300 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300×H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_300,h_300,c_fill'.jpg)\n\n* Example 2 - Fill, with gravity\n```HTML \ng_east,w_300,h_300,c_fill\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W300×H300 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Boat in clear blue ocean: W135×H65](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'g_east,w_300,h_300,c_fill'.jpg)\n\n### fit \n\nAdapts the size of the image to fill a box as much as possible, but in such a way as to be completely visible, while respecting proportionality.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100% \n\n width of the new image\n \n* prefix `h`: a **dimension value**, default value is 100%\n\n height of the new image\n \n* prefix `g`: a **gravity value**\n* prefix `x`: a **dimension value**, default value is 0\n\n the x (easting) of the center point of the source image in the target image\n \n* prefix `y`: a **dimension value**, default value is 0\n\n the y (northing) of the center point of the source image in the target image\n\n* prefix `bg`: the color to fill empty space\n\n* switch `trim`: remove empty space (parameters prefixed with `g`,`x`,`y`or`bg` can't be used with this switch)\n\nExamples: \n* Example 1 - Fit, no gravity\n```HTML \nw_300,h_300,c_fit\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W300×H300 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300×H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_300,h_300,c_fit'.jpg)\n\n* Example 2 - Fit, with gravity\n```HTML \ng_north,w_300,h_300,c_fit\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W300×H300 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300×H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'g_north,w_300,h_300,c_fit'.jpg)\n\n* Example 3 - Fit, with colored background\n```HTML \nbg_aquamarine,w_300,h_300,c_fit\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W300×H300 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W300×H300](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_aquamarine,w_300,h_300,c_fit'.jpg)\n\n### flip\n\nFlips the image vertically (Horizontal axis symmetry).\n\nNo parameters.\n\nExample:\n\n```HTML \nc_flip\n``` \n\n### flop\n\nFlips the image horizontally (Vertical axis symmetry).\n\nNo parameters.\n\nExample:\n\n```HTML \nc_flop\n``` \n\n### format\n\nConvert file to specified format.\n\nParameters:\n\n* prefix `e`: output file extension\n \n Use value `$org` to format to input file extension (can be use to convert to a specific format to chain some commands and finally return to original format)\n \n* prefix `q`: the quality of file for type which handle it (jpeg, mpeg, png, mng, tiff, miff, bpg, webp…​). It’s a positive integer, usually from 0 (or 1) to 100, the lowest means the lowest quality, the highest means highest quality. \n\n* prefix `hv`: a **density value**, the horizontal density of the binary target if source is a vector image (default is `vv` if specified)\n\n* prefix `vv`: a **density value**, the vertical density of the binary target if source is a vector image (default is `hv` if specified)\n\n* switch `dpi`: set the density in dots per inch (default)\n\n* switch `dpc`: set the density in dots per centimeter\n\n* prefix `cp`: clipping path\n\n* switch `outside`: +outside to clip outside or -outside to clip inside\n\nExamples: \n* Example 1 - Convert to png\n```HTML \ne_png,c_format\n```\n\n* Example 2 - Convert to jpeg with specified quality\n```HTML \ne_jpg,q_5,c_format\n```\n\n>💡 to change quality without changing extension, use `$current` value for extension:\n>```HTML \n>e_$current,q_5,c_format\n>```\n\n### layout\n\nThis command just places the image in an image of a certain size.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n width of the target image\n\n\n* prefix `h`: a **dimension value**, default value is 100%\n\n height of the target image\n\n* prefix `g`: a **gravity value**\n* prefix `x`: a **dimension value**, default value is 0 \n\n the x (easting) of the center point of the source image in the target image \n \n* prefix `y`: a **dimension value**, default value is 0\n\n the y (northing) of the center point of the source image in the target image\n\n* prefix `bg`: the color to fill empty space (Only classic color or $dom type color is allowed)\n\nExamples:\n* Example 1 - Simple layout\n```HTML \nbg_dodgerblue,w_600,h_600,c_layout\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W600×H600 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: 600×H600](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_dodgerblue,w_600,h_600,c_layout'.jpg)\n* Example 2 - Layout, specifying location\n```HTML \nbg_dodgerblue,g_east,y_100,w_600,h_600,c_layout\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W600×H600 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: 600×H600](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_dodgerblue,g_east,y_100,w_600,h_600,c_layout'.jpg)\n\n### lresize (liquid resize)\n\nThis command resize the image with the seam carving algorithm, keeping focus on main subjects. Note some parts of he image could be distorted.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n width of the new image\n \n* prefix `h`: a **dimension value**, default value is 100%\n\n height of the new image \n\nExample: liquid resize to 50%, proportionally\n```HTML \n w_proportional,h_50p,c_lresize\n```\n| Input: Madivaru finolhu, Maldives, W320×H400 | Output: Madivaru finolhu, Maldives, W160×H200 | To compare to resize output `w_proportional,h_50p,c_resize` |\n|:------:|:------:|:------:|\n|![Madivaru finolhu, Maldives: W320×H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island.jpg)|![Madivaru finolhu, Maldives: W160×H200](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_lresize'.jpg)|![Madivaru finolhu, Maldives: W160×H200 (resized)](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/island_jpg_'w_proportional,h_50p,c_resize'.jpg)|\n\n### metadata\n\nWrite metadata into image file.\n\nParameters:\n\n* prefix `mv`: specify the name and value of a metadata\n \n * the name must be one of the followings:\n \n * **artist**: \n * **comment**: \n * **copyright**: \n * **DocumentName**: \n * **ImageDescription**: \n * **Make**: \n * **Software**: \n \n * the value is a string value\n \n Example : `mv_copyright=\"Dummy Production\"`\n \n * you can set value from asset metadata\n \n Example : `mv_ImageDescription=prop:description`\n \n * value is patchable\n \n You can specify variables that will be replaced by there corresponding value.\n \n Example : `mv_artist=\"${photograph.firstname} ${photograph.name}\"`\n\n* prefix `ts` allows to set metadata with a json like\n \n ```\n {\n \"artist\":\"${photograph.firstname} ${photograph.name}\",\n \"ImageDescription\":\"prop:description\",\n \"comment\":\"this was exported on July 3, 2020\"\n }\n ```\n\n### pad\n\nAdd some space surrounding the image or to selected sides of the image\n\nThis command resize the image with the seam carving algorithm, keeping focus on main subjects. Note some parts of he image could be distorted.\n\nParameters:\n\n* prefix `t`: a **dimension value**, default value is 0\n\n the amount of top inset (above the image)\n \n* prefix `r`: a **dimension value**, default value is 0\n\n the amount of right inset (on the right of the image)\n\n* prefix `b`: a **dimension value**, default value is 0\n\n the amount of bottom inset (below the image)\n\n* prefix `l`: a **dimension value**, default value is 0\n\n the amount of left inset (on the left of the image)\n \n* prefix `bd`: a **dimension value**, default value is 0\n\n a common default value for top, right, bottom or left inset (default value is 0)\n\n* prefix `bg`: a **dimension value**, default value is 0\n\n the color to fill space\n\nExamples: \n* Example 1 - Borders around\n```HTML \nbd_40,bg_sandybrown,c_pad\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W480×H305 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W480×H305](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bd_40,bg_sandybrown,c_pad'.jpg)\n\n* Example 2 - Selected borders (top and bottom)\n```HTML \nt_40,b_40,bg_sandybrown,c_pad\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H305 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H305](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'t_40,b_40,bg_sandybrown,c_pad'.jpg)\n\n* Example 3 - Different sizes\n```HTML \nbd_10,b_20p,bg_white,c_pad\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W420×H280 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W420×H280](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bd_10,b_20p,bg_white,c_pad'.jpg)\n\n>💡 For Different colors, chain several pad commands \n>```HTML \n>bd_1,bg_black,c_pad,bd_10,bg_white,c_pad,bd_1,bg_black,c_pad\n>```\n| Input: Maldives, W400×H225 | Output: Maldives, W424×H249 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W424×H249](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bd_1,bg_black,c_pad,bd_10,bg_white,c_pad,bd_1,bg_black,c_pad'.jpg)\n \n### preset\n\nApply a preset\n\nParameters:\n\n* prefix `n`: a string\n\n name of preset \n \nExample:\n```HTML \nn_circle_png,c_preset\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W225×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W225×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'n_circle_png,c_preset'.png)\n\n### resample\n\nChange the density (in Dot Per Inches) of the image.\n\nParameters:\n\n* prefix `hv`: a **density value**\n\n the horizontal density\n\n* prefix `vv`: a **density value**\n\n the vertical density\n\nIf only one of the two parameters is specified, the other parameter is equal to it.\n\nExample:\n```HTML \nhv_300,vv_300,c_resample\n```\n\n### rescale\n\nResize the image proportionaly.\n\nParameters:\n\n* prefix `f`: factor\n\n the rescaling factor\n\nExample:\n```HTML \nf_1.5,c_rescale\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W600×H337 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W600×H337](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'f_1.5,c_rescale'.jpg)\n\n### resize\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n width of the new image\n \n* prefix `h`: a **dimension value**, default value is 100%\n\n height of the new image \n\nExamples: \n* Example 1 - Not proportional resizing\n```HTML \nw_125p,h_75p,c_resize\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W500×H168 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W500×H168](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_125p,h_75p,c_resize'.jpg)\n\n* Example 2 - One dimension resizing\n```HTML \nh_200p,c_resize\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H450 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H450](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'h_200p,c_resize'.jpg)\n\n* Example 3 - Proportional resizing\n```HTML \nw_proportional,h_50p,c_resize\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W199×H112 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W199×H112](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_proportional,h_50p,c_resize'.jpg)\n\n* Example 4 - Invert width and height\n```HTML \nw_height,h_width,c_resize\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W225×H400 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W225×H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_height,h_width,c_resize'.jpg)\n\n### rotate\n\nRotates the image.\n\nParameters:\n\n* prefix `a`: angle\n* switch `crop`: crop mode switch\n* prefix `x`: a **dimension value**, default value is 0 \n\n The x (easting) of the top-left corner of the cropping box \n \n* prefix `y`: a **dimension value**, default value is 0\n\n The y (northing) of the top-left corner of the cropping box\n \nExamples: \n* Example 1 - Turn left\n```HTML \na_left,c_rotate\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W225×H400 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W225×H400](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_left,c_rotate'.jpg)\n \n* Example 2 - Turn 45 degrees\n```HTML \na_45,c_rotate\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W444×H443 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W444×H443](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_45,c_rotate'.jpg)\n \n* Example 3 - Turn 45 degrees, fill background with second dominant color\n```HTML \nbg_$dom-1,a_45,c_rotate\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W444×H443 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W444×H443](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'bg_$dom-1,a_45,c_rotate'.jpg)\n\n* Example 4 - Turn 45 degrees, crop to original size\n```HTML \na_45,crop,c_rotate\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_45,crop,c_rotate'.jpg)\n \n* Example 5 - Turn 45 degrees, crop to original size, with focus\n```HTML \na_45,crop,x_50p,y_25p,c_rotate\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'a_45,crop,x_50p,y_25p,c_rotate'.jpg)\n \n### strip\n\nRemoves metadata (Exif, IPTC…​) from image.\n\nNo parameters.\n\nExample:\n\n```HTML \nc_strip\n```\n\n### thumbnail\n\nGenerates a standard thumbnail.\n\nParameters:\n\n* prefix `w`: a **dimension value**, default value is 100%\n\n width of the target image\n\n\n* prefix `h`: a **dimension value**, default value is 100%\n\n height of the target image\n\n* prefix `e`: output file extension\n \n Use value `$org` to format to input file extension (can be use to convert to a specific format to chain some commands and finally return to original format)\n\n* prefix `bg`: background color\n* prefix `q`: the quality of file for type which handle it (jpeg, mpeg, png, mng, tiff, miff, bpg, webp…​). It’s a positive integer, usually from 0 (or 1) to 100, the lowest means the lowest quality, the highest means highest quality. \n* prefix `i`: image index, if origin is a multi-page/multi document (or multi-image file) (integer, default is 0)\n\n* switch `-proportional`: deactivate proportional resizing (true by default)\n* switch `autorotate`: activate self-orientation (based on EXIF image profile setting 'Orientation')\n* switch `zoomin`: activate image fitting\n* switch `extend`: activate image filling\n\nExamples:\n* Example 1 - Simple thumbnail\n```HTML \nw_300,h_300,c_thumbnail\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W300×H168 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: 300×H168](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'w_300,h_300,c_thumbnail'.png)\n\n### watermark\n\nDraws text overlay on image.\n\nParameters:\n\n* prefix `f`: font\n* prefix `bg`: background color\n* prefix `fg`: foreground color\n* prefix `sc`: stroke color\n* prefix `g`: location\n* prefix `x`: x (easting) coordinates\n* prefix `y`: y (northing) coordinates\n* prefix `a`: angle\n* prefix `s`: stroke width\n* prefix `tx`: text \n* prefix `xd`: text decoration\n* prefix `sh`: shade\n* switch `thickeroutline`: increases the thickness of outlines \n\nExamples: \n* Example 1 - Text\n```HTML \ntx_\"\\u00a9Wedia\",f_Candice|25%|bold,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_''_u00a9Wedia'',f_Candice_25p_bold,c_watermark'.jpg)\n \n* Example 2 - Colored text\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|25p|bold,fg_#00A5C8,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_''_u00a9Wedia'',f_Montserrat_25p_bold,fg__00A5C8,c_watermark'.jpg)\n \n* Example 3 - Outlined text\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|50p|heavy,sc_white,fg_none,g_center,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_'_u00a9Wedia,f_Montserrat_50p_heavy,sc_white,fg_none,g_center,c_watermark'.jpg)\n\n* Example 4 - Outlined text, blur effect\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|50p|heavy,sc_white,fg_$blur:25x25,g_center,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'tx_''_u00a9Wedia'',f_Montserrat_50p_heavy,sc_white,fg_$blur_25x25,g_center,c_watermark'.jpg)\n\n* Example 5 - Outlined text, shade effect\n```HTML \ntx_\"\\u00a9Wedia\",f_Montserrat|50p|heavy,sc_white,fg_$blur:25x25,g_center,thickeroutline,sh_45×90,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'watermark_shade_effect'.jpg)\n\n* Example 6 - With or without thickeroutline\n\nWithout:\n```HTML \ntx_\"\\u00a9Wedia\",f_Arial|40p|bold,s_5,sc_black,fg_white,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'without_thickeroutline'.jpg)\n \nWith:\n```HTML \ntx_\"\\u00a9Wedia\",f_Arial|40p|bold,s_5,sc_black,fg_white,thickeroutline,c_watermark\n```\n| Input: Maldives, W400×H225 | Output: Maldives, W400×H225 |\n|:------:|:------:|\n|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives.jpg)|![Maldives: W400×H225](https://club-wed.wedia-group.com:443/api/rest/examples/imaging/maldives_jpg_'with_thickeroutline'.jpg)\n ","version":"2.4","title":"WEDIA JSON API","contact":{"email":"support@wedia-group.com"}},"servers":[{"url":"https://club-wed.wedia-group.com/api/json"}],"tags":[{"name":"view","description":"Operations to get resources.\n______\nGeneral error codes for these operations:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/100|Occurs when the specified resource to get is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/100)|\n\n"},{"name":"updates","description":"Operations to modify resources.\n______\nGeneral error codes for these operations:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/200|Occurs when the specified resource to modify is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/200)|\n\n"},{"name":"creation","description":"Operations to create resources.\n______\nGeneral error codes for these operations:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/200|Occurs when the requested action has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/200)|\n|403/900|Occurs when attempting to set a property that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n"},{"name":"workflows","description":"Operations to process resource workflows.\n______\nGeneral error codes for these operations:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/200|Occurs when the specified resource is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/200)|\n\n"},{"name":"delete","description":"Operations to delete resources.\n______\nGeneral error codes for these operations:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/200|Occurs when the specified resource to delete is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/200)|\n\n"},{"name":"imaging","description":"Transform images.\n______\nGeneral error codes for these operations:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/200|Occurs when the specified resource to transform is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/200)|\n\n","externalDocs":{"url":"https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations#commands","description":"Documentation of the REST WEDIA API configuration"}},{"name":"user","description":"Operations to handle current connected user resources"}],"paths":{"/view/assets":{"get":{"summary":"Get a list of asset","description":"Get a paginated list of asset as defined in the view.\n\n\n\n> Application base DAM object\n","tags":["view"],"parameters":[{"name":"props","in":"query","description":"Filters exported properties (A Comma-Separated list of properties).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"query","in":"query","description":"Filters exported resources.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY or in body if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"orderby","in":"query","description":"Sort orders","schema":{"type":"array","items":{"type":"string","pattern":"^.*? ([Aa]|[Dd]|asc|desc)$","example":"prop1 asc, prop2 desc"}},"style":"form","explode":false,"required":false},{"name":"sortbyrelevance","in":"query","description":"If true, and fulltext search, sort first by relevance then user orderby. If false, sort only by orderby.","schema":{"type":"boolean","example":false},"required":false},{"name":"fulltext","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"from","in":"query","description":"Offset: index of first element to get (from 1).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false},"required":false},{"name":"max","in":"query","description":"Maximum number of resources exported in response (if omitted, default value is 50).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false,"maximum":200,"exclusiveMaximum":false},"required":false},{"name":"i18n","in":"query","description":"overrides localized configuration parameter of the view","schema":{"type":"boolean"},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"aggHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the aggregates. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response. \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"A list of asset (may be empty if none have been found)","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"ID of resource.","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/view/assets"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of asset resources.\n\n\n\n> Application base DAM object\n","readOnly":true,"items":{"$ref":"#/components/schemas/view-assets"}},"total":{"type":"integer","format":"int64","description":"Total number of resources","readOnly":true,"example":854215},"count":{"type":"integer","format":"int64","description":"Number of resources in this response","readOnly":true,"example":50}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invocation is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/100|Occurs when the consumer does not have the right to invoke this end point.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/100)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/100"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Access forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/100"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when a request parameter is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Occurs when there is an error in the JSon Query.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1200)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request (JSON Query: syntax error)"},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/view/assets/{resourceId}":{"get":{"summary":"Get a given asset resource","description":"Get a asset corresponding to specified id according to the configured view.\n\n\n\n> Application base DAM object\n","tags":["view"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to get.","schema":{"type":"integer"},"required":true},{"name":"props","in":"query","description":"Filters exported properties (A Comma-Separated list of properties).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"query","in":"query","description":"Filters exported resources.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY or in body if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"orderby","in":"query","description":"Sort orders","schema":{"type":"array","items":{"type":"string","pattern":"^.*? ([Aa]|[Dd]|asc|desc)$","example":"prop1 asc, prop2 desc"}},"style":"form","explode":false,"required":false},{"name":"sortbyrelevance","in":"query","description":"If true, and fulltext search, sort first by relevance then user orderby. If false, sort only by orderby.","schema":{"type":"boolean","example":false},"required":false},{"name":"fulltext","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"from","in":"query","description":"Offset: index of first element to get (from 1).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false},"required":false},{"name":"max","in":"query","description":"Maximum number of resources exported in response (if omitted, default value is 50).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false,"maximum":200,"exclusiveMaximum":false},"required":false},{"name":"i18n","in":"query","description":"overrides localized configuration parameter of the view","schema":{"type":"boolean"},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"aggHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the aggregates. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response. \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"A list with one asset resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"ID of resource.","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/view/assets/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"$ref":"#/components/schemas/view-assets"},"total":{"type":"integer","format":"int64","description":"Total number of resources","readOnly":true,"example":854215},"count":{"type":"integer","format":"int64","description":"Number of resources in this response","readOnly":true,"example":50}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/100|Occurs when the consumer does not have the right to get asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/100)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/100"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Access forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/100"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when the specified resource id of asset is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/view/transfer":{"get":{"summary":"Get a list of transfer","description":"Get a paginated list of transfer as defined in the view.","tags":["view"],"parameters":[{"name":"props","in":"query","description":"Filters exported properties (A Comma-Separated list of properties).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"query","in":"query","description":"Filters exported resources.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY or in body if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"orderby","in":"query","description":"Sort orders","schema":{"type":"array","items":{"type":"string","pattern":"^.*? ([Aa]|[Dd]|asc|desc)$","example":"prop1 asc, prop2 desc"}},"style":"form","explode":false,"required":false},{"name":"sortbyrelevance","in":"query","description":"If true, and fulltext search, sort first by relevance then user orderby. If false, sort only by orderby.","schema":{"type":"boolean","example":false},"required":false},{"name":"fulltext","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"from","in":"query","description":"Offset: index of first element to get (from 1).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false},"required":false},{"name":"max","in":"query","description":"Maximum number of resources exported in response (if omitted, default value is 50).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false,"maximum":200,"exclusiveMaximum":false},"required":false},{"name":"i18n","in":"query","description":"overrides localized configuration parameter of the view","schema":{"type":"boolean"},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"aggHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the aggregates. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response. \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"A list of transfer (may be empty if none have been found)","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"ID of resource.","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/view/transfer"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"type":"array","description":"List of transfer resources.","readOnly":true,"items":{"$ref":"#/components/schemas/view-transfer"}},"total":{"type":"integer","format":"int64","description":"Total number of resources","readOnly":true,"example":854215},"count":{"type":"integer","format":"int64","description":"Number of resources in this response","readOnly":true,"example":50}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invocation is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/100|Occurs when the consumer does not have the right to invoke this end point.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/100)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/100"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Access forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/100"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when a request parameter is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1200|Occurs when there is an error in the JSon Query.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1200)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request (JSON Query: syntax error)"},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/view/transfer/{resourceId}":{"get":{"summary":"Get a given transfer resource","description":"Get a transfer corresponding to specified id according to the configured view.","tags":["view"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to get.","schema":{"type":"integer"},"required":true},{"name":"props","in":"query","description":"Filters exported properties (A Comma-Separated list of properties).","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false,"required":false},{"name":"query","in":"query","description":"Filters exported resources.\n\n[See JSON query syntax](#section/filters:-JSON-Query-syntax)\n\nℹ This parameter can be put in header X-WEDIA-QUERY or in body if value is too long in query.","schema":{"type":"object","additionalProperties":{}},"required":false},{"name":"orderby","in":"query","description":"Sort orders","schema":{"type":"array","items":{"type":"string","pattern":"^.*? ([Aa]|[Dd]|asc|desc)$","example":"prop1 asc, prop2 desc"}},"style":"form","explode":false,"required":false},{"name":"sortbyrelevance","in":"query","description":"If true, and fulltext search, sort first by relevance then user orderby. If false, sort only by orderby.","schema":{"type":"boolean","example":false},"required":false},{"name":"fulltext","in":"query","description":"Full text search string.","schema":{"type":"string"},"required":false},{"name":"from","in":"query","description":"Offset: index of first element to get (from 1).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false},"required":false},{"name":"max","in":"query","description":"Maximum number of resources exported in response (if omitted, default value is 50).","schema":{"type":"integer","format":"int32","minimum":1,"exclusiveMinimum":false,"maximum":200,"exclusiveMaximum":false},"required":false},{"name":"i18n","in":"query","description":"overrides localized configuration parameter of the view","schema":{"type":"boolean"},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports descriptions (types, labels, available features, form structures...).","schema":{"type":"boolean","default":false},"required":false},{"name":"aggHeaders","in":"query","description":"Exports descriptions (types, labels, available features, form structures...) for the aggregates. The default value of this parameter is that of the headers parameter.","schema":{"type":"boolean","default":false},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response. \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"A list with one transfer resource","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"string","description":"ID of resource.","readOnly":true},"description":{"type":"string","description":"Description of resource.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/view/transfer/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"data":{"$ref":"#/components/schemas/view-transfer"},"total":{"type":"integer","format":"int64","description":"Total number of resources","readOnly":true,"example":854215},"count":{"type":"integer","format":"int64","description":"Number of resources in this response","readOnly":true,"example":50}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/100|Occurs when the consumer does not have the right to get transfer.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/100)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/100"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Access forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/100"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when the specified resource id of transfer is not found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.asset.add":{"post":{"summary":"Creates a asset resource","description":"Creates a new asset resource.\n\n\n\n> Application base DAM object\n","tags":["creation"],"parameters":[{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"report","in":"query","description":"If true, reports the created asset data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.asset.add).","readOnly":true,"example":"dam.data.asset.add"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.asset.add"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created asset in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/create_report-dam.data.asset.add"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the asset couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/unsplashimport":{"post":{"summary":"Creates a asset resource","description":"Creates a new asset resource.\n\n\n\n> Application base DAM object\n","tags":["creation"],"parameters":[{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":true},{"name":"prop_keywords","in":"query","description":"Keyword of keyword to find the corresponding identifier to set to property keywords.","schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Keyword instead of passing a Keyword to find it."}}},{"description":"Keyword of keyword.","type":"string"}]},"required":true},{"name":"prop_photograph","in":"query","description":"Last Name of photographer to find the corresponding identifier to set to property studio / agency.","schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Photographer instead of passing a Last Name to find it."}}},{"description":"Last Name of photographer.","type":"string"}]},"required":true}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Keyword of keyword to find the corresponding identifier to set to property keywords.","type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Keyword instead of passing a Keyword to find it."}}},{"description":"Keyword of keyword.","type":"string"}]},"uniqueItems":true},"prop_photograph":{"description":"Last Name of photographer to find the corresponding identifier to set to property studio / agency.","oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Photographer instead of passing a Last Name to find it."}}},{"description":"Last Name of photographer.","type":"string"}]}},"required":["prop_description","prop_keywords","prop_photograph"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (unsplashimport).","readOnly":true,"example":"unsplashimport"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/unsplashimport"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created asset in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the asset couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.brandcenter.add":{"post":{"summary":"Creates a brand center resource","description":"Creates a new brand center resource.\n\n\n\n> Unique DAM funds for the WEDIA PACKAGED application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["creation"],"parameters":[{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"report","in":"query","description":"If true, reports the created brand center data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.brandcenter.add).","readOnly":true,"example":"dam.data.brandcenter.add"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.brandcenter.add"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created brand center in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/create_report-dam.data.brandcenter.add"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create brand center.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the brand center couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.asset.assetcoverage.define":{"post":{"summary":"Creates a collection resource","description":"Creates a new collection resource.","tags":["creation"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"}},"required":["prop_name","prop_description"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.asset.assetcoverage.define).","readOnly":true,"example":"dam.data.asset.assetcoverage.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.asset.assetcoverage.define"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created collection in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create collection.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the collection couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/damimport":{"post":{"summary":"Creates a damimport resource","description":"Creates a new damimport resource.","tags":["creation"],"parameters":[{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"prop_damobjectname","in":"query","description":"Value to set to property damobjectname.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2},"prop_damobjectname":{"description":"Value to set to property damobjectname.","type":"string"}},"required":["prop_damobjectname"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (damimport).","readOnly":true,"example":"damimport"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/damimport"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created damimport in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create damimport.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the damimport couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/data.transfer.add":{"post":{"summary":"Creates a data.transfer.add resource","description":"Creates a new data.transfer.add resource.","tags":["creation"],"parameters":[{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (data.transfer.add).","readOnly":true,"example":"data.transfer.add"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/data.transfer.add"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created data.transfer.add in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create data.transfer.add.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the data.transfer.add couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.asset.folder.define":{"post":{"summary":"Creates a folder resource","description":"Creates a new folder resource.","tags":["creation"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.asset.folder.define).","readOnly":true,"example":"dam.data.asset.folder.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.asset.folder.define"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created folder in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create folder.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the folder couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.assetgeography.define":{"post":{"summary":"Creates a geographical thesaurus resource","description":"Creates a new geographical thesaurus resource.","tags":["creation"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_generic","in":"query","description":"Identifier of geographical thesaurus to set to property tag","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_generic":{"description":"Identifier of geographical thesaurus to set to property tag","type":"string"}},"required":["prop_name","prop_generic"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.assetgeography.define).","readOnly":true,"example":"dam.data.assetgeography.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.assetgeography.define"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created geographical thesaurus in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create geographical thesaurus.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the geographical thesaurus couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.asset.assetkeyword.define":{"post":{"summary":"Creates a keyword resource","description":"Creates a new keyword resource.","tags":["creation"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property keyword.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property keyword.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.asset.assetkeyword.define).","readOnly":true,"example":"dam.data.asset.assetkeyword.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.asset.assetkeyword.define"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created keyword in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create keyword.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the keyword couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.legacy.add":{"post":{"summary":"Creates a legacy resource","description":"Creates a new legacy resource.\n\n\n\n> Legacy assets in the demo application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["creation"],"parameters":[{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"report","in":"query","description":"If true, reports the created legacy data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.legacy.add).","readOnly":true,"example":"dam.data.legacy.add"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.legacy.add"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created legacy in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/create_report-dam.data.legacy.add"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create legacy.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the legacy couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/dam.data.assetauthor.define":{"post":{"summary":"Creates a photographer resource","description":"Creates a new photographer resource.","tags":["creation"],"parameters":[{"name":"prop_name","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property last name.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (dam.data.assetauthor.define).","readOnly":true,"example":"dam.data.assetauthor.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/dam.data.assetauthor.define"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created photographer in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create photographer.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the photographer couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/register":{"post":{"summary":"Creates a user resource","description":"Creates a new user resource.","tags":["creation"],"parameters":[{"name":"prop_email","in":"query","description":"Value to set to property email.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_email":{"description":"Value to set to property email.","type":"string"}},"required":["prop_email"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (register).","readOnly":true,"example":"register"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/register"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created user in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the user couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/create/user":{"post":{"summary":"Creates a user resource","description":"Creates a new user resource.","tags":["creation"],"parameters":[{"name":"prop_lastname","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property display name.","schema":{"type":"string"},"required":true},{"name":"prop_email","in":"query","description":"Value to set to property email.","schema":{"type":"string"},"required":true},{"name":"prop_internal","in":"query","description":"Value to set to property internal.","schema":{"type":"boolean"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_lastname":{"description":"Value to set to property last name.","type":"string"},"prop_name":{"description":"Value to set to property display name.","type":"string"},"prop_email":{"description":"Value to set to property email.","type":"string"},"prop_internal":{"description":"Value to set to property internal.","type":"boolean"}},"required":["prop_lastname","prop_name","prop_email","prop_internal"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"201":{"description":"Result of creation","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of created resource type (user).","readOnly":true,"example":"user"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/create/user"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"createdId":{"type":"integer","format":"int32","description":"ID of created user in case of creation","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this end point is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/200|Occurs when the consumer does not have the right to create user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/200)|\n|403/203|Occurs when the user couldn't be created with the specified values.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/203)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/200"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/200"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there are already requests and the queues are full..\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.asset.add/{resourceId}":{"put":{"summary":"Modify a given asset resource","description":"Modify specified asset.\n\n\n\n> Application base DAM object\n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"report","in":"query","description":"If true, reports the modified asset data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.add).","readOnly":true,"example":"dam.data.asset.add"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.add/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated asset in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/create_report-dam.data.asset.add"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given asset (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given asset resource","description":"Modify specified asset.\n\n\n\n> Application base DAM object\n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"report","in":"query","description":"If true, reports the modified asset data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.add).","readOnly":true,"example":"dam.data.asset.add"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.add/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated asset in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/create_report-dam.data.asset.add"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given asset (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.asset.update/{resourceId}":{"put":{"summary":"Modify a given asset resource","description":"Modify specified asset.\n\n\n\n> Application base DAM object\n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":true},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"required":true},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"required":true},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"required":true},{"name":"prop_location","in":"query","description":"Identifier of geographical thesaurus to set to property location","schema":{"type":"string"},"required":true},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","schema":{"type":"string"},"required":true},{"name":"prop_coverage","in":"query","description":"Identifier of collection to set to property collection","schema":{"type":"string"},"required":true},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"type":"string"},"required":true},{"name":"prop_righttype","in":"query","description":"Identifier of rights to set to property right types","schema":{"type":"string"},"required":true},{"name":"prop_photograph","in":"query","description":"Identifier of photographer to set to property studio / agency","schema":{"type":"string"},"required":true},{"name":"prop_dteendrights","in":"query","description":"Value to set to property expiration date.","schema":{"oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}]},"required":true,"example":"2019-07-08"},{"name":"report","in":"query","description":"If true, reports the modified asset data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},"prop_folder":{"description":"Identifiers of folder to set property folder","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},"prop_location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"prop_season":{"description":"Identifier of season to set to property season","type":"string"},"prop_coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"prop_copyright":{"description":"Value to set to property copyright.","type":"string"},"prop_righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"prop_photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"prop_dteendrights":{"description":"Value to set to property expiration date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"}},"required":["prop_name","prop_description","prop_keywords","prop_authorizedchannel","prop_folder","prop_location","prop_season","prop_coverage","prop_copyright","prop_righttype","prop_photograph","prop_dteendrights"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.update).","readOnly":true,"example":"dam.data.asset.update"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated asset in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/update_report-dam.data.asset.update"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given asset (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given asset resource","description":"Modify specified asset.\n\n\n\n> Application base DAM object\n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"required":false},{"name":"prop_folder","in":"query","description":"Identifiers of folder to set property folder","schema":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"required":false},{"name":"prop_location","in":"query","description":"Identifier of geographical thesaurus to set to property location","schema":{"type":"string"},"required":false},{"name":"prop_season","in":"query","description":"Identifier of season to set to property season","schema":{"type":"string"},"required":false},{"name":"prop_coverage","in":"query","description":"Identifier of collection to set to property collection","schema":{"type":"string"},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"type":"string"},"required":false},{"name":"prop_righttype","in":"query","description":"Identifier of rights to set to property right types","schema":{"type":"string"},"required":false},{"name":"prop_photograph","in":"query","description":"Identifier of photographer to set to property studio / agency","schema":{"type":"string"},"required":false},{"name":"prop_dteendrights","in":"query","description":"Value to set to property expiration date.","schema":{"oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}]},"required":false,"example":"2019-07-08"},{"name":"report","in":"query","description":"If true, reports the modified asset data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2},"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},"prop_folder":{"description":"Identifiers of folder to set property folder","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Folder."},{"type":"integer","format":"int32","description":"ID of Folder."}]},"uniqueItems":true},"prop_location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"prop_season":{"description":"Identifier of season to set to property season","type":"string"},"prop_coverage":{"description":"Identifier of collection to set to property collection","type":"string"},"prop_copyright":{"description":"Value to set to property copyright.","type":"string"},"prop_righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"prop_photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"prop_dteendrights":{"description":"Value to set to property expiration date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.update).","readOnly":true,"example":"dam.data.asset.update"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated asset in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/update_report-dam.data.asset.update"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given asset (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/unsplashimport/{resourceId}":{"put":{"summary":"Modify a given asset resource","description":"Modify specified asset.\n\n\n\n> Application base DAM object\n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":true},{"name":"prop_keywords","in":"query","description":"Keyword of keyword to find the corresponding identifier to set to property keywords.","schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Keyword instead of passing a Keyword to find it."}}},{"description":"Keyword of keyword.","type":"string"}]},"required":true},{"name":"prop_photograph","in":"query","description":"Last Name of photographer to find the corresponding identifier to set to property studio / agency.","schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Photographer instead of passing a Last Name to find it."}}},{"description":"Last Name of photographer.","type":"string"}]},"required":true}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Keyword of keyword to find the corresponding identifier to set to property keywords.","type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Keyword instead of passing a Keyword to find it."}}},{"description":"Keyword of keyword.","type":"string"}]},"uniqueItems":true},"prop_photograph":{"description":"Last Name of photographer to find the corresponding identifier to set to property studio / agency.","oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Photographer instead of passing a Last Name to find it."}}},{"description":"Last Name of photographer.","type":"string"}]}},"required":["prop_description","prop_keywords","prop_photograph"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (unsplashimport).","readOnly":true,"example":"unsplashimport"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/unsplashimport/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated asset in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given asset (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given asset resource","description":"Modify specified asset.\n\n\n\n> Application base DAM object\n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_binary","in":"query","description":"Name, or URI, of the file to store in the property file","schema":{"anyOf":[{"type":"string","description":"Simple file name"},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]},"required":false,"style":"form","explode":true},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Keyword of keyword to find the corresponding identifier to set to property keywords.","schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Keyword instead of passing a Keyword to find it."}}},{"description":"Keyword of keyword.","type":"string"}]},"required":false},{"name":"prop_photograph","in":"query","description":"Last Name of photographer to find the corresponding identifier to set to property studio / agency.","schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Photographer instead of passing a Last Name to find it."}}},{"description":"Last Name of photographer.","type":"string"}]},"required":false}],"requestBody":{"description":"You can upload a binary file within body or within a multipart/form-data field. You can also set other properties within the multipart/form-data fields, or query parameters (query parameters always override form fields, except for binary).\n\nIf you upload a file within the request body, you have to provide a filename using the corresponding query parameters (prop_binary by example), as the stored mimetype is always determined using the filename suffix.\nThe query parameters other than binary fields parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_binary":{"description":"Name, URI of the file or binary content to store in the property file","type":"array","items":{"anyOf":[{"type":"string","description":"Simple file name"},{"oneOf":[{"type":"string","format":"binary","description":"Binary file [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media)."},{"type":"string","format":"uri","description":"URI of file (in this case the binary uploaded file will be ignored)"}]}]},"minItems":1,"maxItems":2},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Keyword of keyword to find the corresponding identifier to set to property keywords.","type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Keyword instead of passing a Keyword to find it."}}},{"description":"Keyword of keyword.","type":"string"}]},"uniqueItems":true},"prop_photograph":{"description":"Last Name of photographer to find the corresponding identifier to set to property studio / agency.","oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"Set directly the identifier of Photographer instead of passing a Last Name to find it."}}},{"description":"Last Name of photographer.","type":"string"}]}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (unsplashimport).","readOnly":true,"example":"unsplashimport"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/unsplashimport/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated asset in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create asset.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given asset (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.brandcenter.update/{resourceId}":{"put":{"summary":"Modify a given brand center resource","description":"Modify specified brand center.\n\n\n\n> Unique DAM funds for the WEDIA PACKAGED application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":true},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"required":true},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"type":"string"},"required":true},{"name":"prop_righttype","in":"query","description":"Identifier of rights to set to property right types","schema":{"type":"string"},"required":true},{"name":"prop_photograph","in":"query","description":"Identifier of photographer to set to property studio / agency","schema":{"type":"string"},"required":true},{"name":"prop_dteendrights","in":"query","description":"Value to set to property expiration date.","schema":{"oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}]},"required":true,"example":"2019-07-08"},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"required":true},{"name":"report","in":"query","description":"If true, reports the modified brand center data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},"prop_copyright":{"description":"Value to set to property copyright.","type":"string"},"prop_righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"prop_photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"prop_dteendrights":{"description":"Value to set to property expiration date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true}},"required":["prop_name","prop_description","prop_keywords","prop_copyright","prop_righttype","prop_photograph","prop_dteendrights","prop_authorizedchannel"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.brandcenter.update).","readOnly":true,"example":"dam.data.brandcenter.update"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.brandcenter.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated brand center in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/update_report-dam.data.brandcenter.update"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create brand center.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given brand center (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given brand center resource","description":"Modify specified brand center.\n\n\n\n> Unique DAM funds for the WEDIA PACKAGED application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"type":"string"},"required":false},{"name":"prop_righttype","in":"query","description":"Identifier of rights to set to property right types","schema":{"type":"string"},"required":false},{"name":"prop_photograph","in":"query","description":"Identifier of photographer to set to property studio / agency","schema":{"type":"string"},"required":false},{"name":"prop_dteendrights","in":"query","description":"Value to set to property expiration date.","schema":{"oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}]},"required":false,"example":"2019-07-08"},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"required":false},{"name":"report","in":"query","description":"If true, reports the modified brand center data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},"prop_copyright":{"description":"Value to set to property copyright.","type":"string"},"prop_righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"prop_photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"prop_dteendrights":{"description":"Value to set to property expiration date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.brandcenter.update).","readOnly":true,"example":"dam.data.brandcenter.update"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.brandcenter.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated brand center in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/update_report-dam.data.brandcenter.update"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create brand center.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given brand center (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.asset.assetcoverage.define/{resourceId}":{"put":{"summary":"Modify a given collection resource","description":"Modify specified collection.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"}},"required":["prop_name","prop_description"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.assetcoverage.define).","readOnly":true,"example":"dam.data.asset.assetcoverage.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.assetcoverage.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated collection in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create collection.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given collection (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given collection resource","description":"Modify specified collection.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property description.","schema":{"type":"string"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property description.","type":"string"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.assetcoverage.define).","readOnly":true,"example":"dam.data.asset.assetcoverage.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.assetcoverage.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated collection in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create collection.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given collection (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.asset.folder.define/{resourceId}":{"put":{"summary":"Modify a given folder resource","description":"Modify specified folder.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.folder.define).","readOnly":true,"example":"dam.data.asset.folder.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.folder.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated folder in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create folder.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given folder (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given folder resource","description":"Modify specified folder.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.folder.define).","readOnly":true,"example":"dam.data.asset.folder.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.folder.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated folder in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create folder.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given folder (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.assetgeography.define/{resourceId}":{"put":{"summary":"Modify a given geographical thesaurus resource","description":"Modify specified geographical thesaurus.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_generic","in":"query","description":"Identifier of geographical thesaurus to set to property tag","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_generic":{"description":"Identifier of geographical thesaurus to set to property tag","type":"string"}},"required":["prop_name","prop_generic"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.assetgeography.define).","readOnly":true,"example":"dam.data.assetgeography.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.assetgeography.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated geographical thesaurus in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create geographical thesaurus.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given geographical thesaurus (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given geographical thesaurus resource","description":"Modify specified geographical thesaurus.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_generic","in":"query","description":"Identifier of geographical thesaurus to set to property tag","schema":{"type":"string"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_generic":{"description":"Identifier of geographical thesaurus to set to property tag","type":"string"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.assetgeography.define).","readOnly":true,"example":"dam.data.assetgeography.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.assetgeography.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated geographical thesaurus in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create geographical thesaurus.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given geographical thesaurus (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.asset.assetkeyword.define/{resourceId}":{"put":{"summary":"Modify a given keyword resource","description":"Modify specified keyword.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property keyword.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property keyword.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.assetkeyword.define).","readOnly":true,"example":"dam.data.asset.assetkeyword.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.assetkeyword.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated keyword in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create keyword.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given keyword (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given keyword resource","description":"Modify specified keyword.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property keyword.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property keyword.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.asset.assetkeyword.define).","readOnly":true,"example":"dam.data.asset.assetkeyword.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.asset.assetkeyword.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated keyword in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create keyword.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given keyword (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.legacy.update/{resourceId}":{"put":{"summary":"Modify a given legacy resource","description":"Modify specified legacy.\n\n\n\n> Legacy assets in the demo application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":true},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":true},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"required":true},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"required":true},{"name":"prop_location","in":"query","description":"Identifier of geographical thesaurus to set to property location","schema":{"type":"string"},"required":true},{"name":"prop_coverage","in":"query","description":"Identifier of collection to set to property thematic collection","schema":{"type":"string"},"required":true},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"type":"string"},"required":true},{"name":"prop_righttype","in":"query","description":"Identifier of rights to set to property right types","schema":{"type":"string"},"required":true},{"name":"prop_photograph","in":"query","description":"Identifier of photographer to set to property studio / agency","schema":{"type":"string"},"required":true},{"name":"prop_dteendrights","in":"query","description":"Value to set to property expiration date.","schema":{"oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}]},"required":true,"example":"2019-07-08"},{"name":"report","in":"query","description":"If true, reports the modified legacy data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},"prop_location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"prop_coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"prop_copyright":{"description":"Value to set to property copyright.","type":"string"},"prop_righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"prop_photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"prop_dteendrights":{"description":"Value to set to property expiration date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"}},"required":["prop_name","prop_description","prop_keywords","prop_authorizedchannel","prop_location","prop_coverage","prop_copyright","prop_righttype","prop_photograph","prop_dteendrights"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.legacy.update).","readOnly":true,"example":"dam.data.legacy.update"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.legacy.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated legacy in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/update_report-dam.data.legacy.update"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create legacy.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given legacy (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given legacy resource","description":"Modify specified legacy.\n\n\n\n> Legacy assets in the demo application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property name.","schema":{"type":"string"},"required":false},{"name":"prop_description","in":"query","description":"Value to set to property caption.","schema":{"type":"string"},"required":false},{"name":"prop_keywords","in":"query","description":"Identifiers of keyword to set property keywords","schema":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"required":false},{"name":"prop_authorizedchannel","in":"query","description":"Identifiers of channel to set property rights managed channels","schema":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"required":false},{"name":"prop_location","in":"query","description":"Identifier of geographical thesaurus to set to property location","schema":{"type":"string"},"required":false},{"name":"prop_coverage","in":"query","description":"Identifier of collection to set to property thematic collection","schema":{"type":"string"},"required":false},{"name":"prop_copyright","in":"query","description":"Value to set to property copyright.","schema":{"type":"string"},"required":false},{"name":"prop_righttype","in":"query","description":"Identifier of rights to set to property right types","schema":{"type":"string"},"required":false},{"name":"prop_photograph","in":"query","description":"Identifier of photographer to set to property studio / agency","schema":{"type":"string"},"required":false},{"name":"prop_dteendrights","in":"query","description":"Value to set to property expiration date.","schema":{"oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}]},"required":false,"example":"2019-07-08"},{"name":"report","in":"query","description":"If true, reports the modified legacy data.","schema":{"type":"boolean"},"required":false},{"name":"headers","in":"query","description":"Exports the definition of data structures in the response. Relevant only if *report* is true.","schema":{"type":"boolean","default":false},"required":false},{"name":"rawValues","in":"query","description":"True to disable localization of reported data. Relevant only if *report* is true.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property name.","type":"string"},"prop_description":{"description":"Value to set to property caption.","type":"string"},"prop_keywords":{"description":"Identifiers of keyword to set property keywords","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Keyword."},{"type":"integer","format":"int32","description":"ID of Keyword."}]},"uniqueItems":true},"prop_authorizedchannel":{"description":"Identifiers of channel to set property rights managed channels","type":"array","items":{"oneOf":[{"type":"string","description":"ID of Channel."},{"type":"integer","format":"int32","description":"ID of Channel."}]},"uniqueItems":true},"prop_location":{"description":"Identifier of geographical thesaurus to set to property location","type":"string"},"prop_coverage":{"description":"Identifier of collection to set to property thematic collection","type":"string"},"prop_copyright":{"description":"Value to set to property copyright.","type":"string"},"prop_righttype":{"description":"Identifier of rights to set to property right types","type":"string"},"prop_photograph":{"description":"Identifier of photographer to set to property studio / agency","type":"string"},"prop_dteendrights":{"description":"Value to set to property expiration date.","oneOf":[{"type":"string","format":"date","description":"ISO formatted date"},{"type":"integer","format":"int64","description":"UNIX epoch time timestamp"}],"example":"2019-07-08"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.legacy.update).","readOnly":true,"example":"dam.data.legacy.update"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.legacy.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated legacy in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"},"data":{"$ref":"#/components/schemas/update_report-dam.data.legacy.update"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create legacy.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given legacy (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/dam.data.assetauthor.define/{resourceId}":{"put":{"summary":"Modify a given photographer resource","description":"Modify specified photographer.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property last name.","type":"string"}},"required":["prop_name"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.assetauthor.define).","readOnly":true,"example":"dam.data.assetauthor.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.assetauthor.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated photographer in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create photographer.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given photographer (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given photographer resource","description":"Modify specified photographer.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_name":{"description":"Value to set to property last name.","type":"string"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (dam.data.assetauthor.define).","readOnly":true,"example":"dam.data.assetauthor.define"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/dam.data.assetauthor.define/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated photographer in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create photographer.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given photographer (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/data.userlang/{resourceId}":{"put":{"summary":"Modify a given user resource","description":"Modify specified user.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_bolang","in":"query","description":"Identifier of language to set to property interface language","schema":{"type":"string"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_bolang":{"description":"Identifier of language to set to property interface language","type":"string"}},"required":["prop_bolang"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (data.userlang).","readOnly":true,"example":"data.userlang"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/data.userlang/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated user in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given user (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given user resource","description":"Modify specified user.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_bolang","in":"query","description":"Identifier of language to set to property interface language","schema":{"type":"string"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_bolang":{"description":"Identifier of language to set to property interface language","type":"string"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (data.userlang).","readOnly":true,"example":"data.userlang"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/data.userlang/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated user in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given user (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/update/user/{resourceId}":{"put":{"summary":"Modify a given user resource","description":"Modify specified user.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_lastname","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":true},{"name":"prop_name","in":"query","description":"Value to set to property display name.","schema":{"type":"string"},"required":true},{"name":"prop_email","in":"query","description":"Value to set to property email.","schema":{"type":"string"},"required":true},{"name":"prop_internal","in":"query","description":"Value to set to property internal.","schema":{"type":"boolean"},"required":true}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_lastname":{"description":"Value to set to property last name.","type":"string"},"prop_name":{"description":"Value to set to property display name.","type":"string"},"prop_email":{"description":"Value to set to property email.","type":"string"},"prop_internal":{"description":"Value to set to property internal.","type":"boolean"}},"required":["prop_lastname","prop_name","prop_email","prop_internal"]}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of update","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (user).","readOnly":true,"example":"user"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/user/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated user in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/201|Occurs when the consumer does not have the right to modify or create user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/201)|\n|403/205|Occurs when the consumer does not have the right to modify the given user (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/201"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/201"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Something is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when no object matching a specified identifier has been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n|404/1100|Occurs when the requested image processing action has not been found|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/1100)|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when one or more mandatory fields (to set to resource) are missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/900|Occurs when an attempt is made to assign a forbidden value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Modify partially a given user resource","description":"Modify specified user.","tags":["updates"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource to modify.","schema":{"type":"integer"},"required":true},{"name":"prop_lastname","in":"query","description":"Value to set to property last name.","schema":{"type":"string"},"required":false},{"name":"prop_name","in":"query","description":"Value to set to property display name.","schema":{"type":"string"},"required":false},{"name":"prop_email","in":"query","description":"Value to set to property email.","schema":{"type":"string"},"required":false},{"name":"prop_internal","in":"query","description":"Value to set to property internal.","schema":{"type":"boolean"},"required":false}],"requestBody":{"description":"You can set properties within the multipart/form-data fields, or query parameters (query parameters always override form fields).\n\nThe query parameters does always override the multipart/form-data fields.\n___","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"prop_lastname":{"description":"Value to set to property last name.","type":"string"},"prop_name":{"description":"Value to set to property display name.","type":"string"},"prop_email":{"description":"Value to set to property email.","type":"string"},"prop_internal":{"description":"Value to set to property internal.","type":"boolean"}}}},"*/*":{"schema":{"description":"The content of the file to upload. [See supported file types](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/1063125046/Supported+formats+in+Media).","type":"string","format":"binary"}}}},"responses":{"200":{"description":"Result of patch","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of modified resource type (user).","readOnly":true,"example":"user"},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/update/user/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","description":"Request response","readOnly":true,"properties":{"updatedId":{"type":"integer","format":"int32","description":"ID of udpated user in case of modification","readOnly":true,"example":"123"},"info":{"description":"Specific informations about done operation, if any"}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"403":{"description":"Occurs when invoking this request is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/202|Occurs when the consumer does not have the right to modify or create user.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/202)|\n|403/205|Occurs when the consumer does not have the right to modify the given user (the current values doesn't allow it or the new values aren't accepted).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/205)|\n|403/900|Occurs when attempting to set a field that can't be (Not supported or not allowed).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/202"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/202"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when the resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/2|Occurs when the database structure that the resource represents does not exist.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/2)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/2"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Illegal state. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/2"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/1|Occurs when an attempt is made to assign a null or empty value to a field that does not have a default value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/1)|\n|400/2|Occurs when an attempt is made to assign multiple values to a field that accepts only one value.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/2)|\n|400/3|Occurs when an attempt is made to assign an inappropriate value to a field.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n|400/9|Occurs during a resource creation or modification, when an error on the data is encountered (missing mandatory property, wrong value, unicity not respected, etc).|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/9)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"409":{"description":"Occurs when there is a conflict between several competing requests and the queues are full.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|409/1|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/1)|\n|409/2|Occurs when there are competing change requests on an already locked resource and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/2)|\n|409/3|Occurs when there are competing change requests and a mutual exclusion lock (timeout) is not obtained.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#409/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"409/1"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Too many competing requests in progress. Try again later."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#409/1"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/workflow/dam.data.asset.update/{resourceId}":{"get":{"summary":"Gets given asset workflow actions.","description":"Gets the list of possible workflow actions for the specified ID asset.\n\n\n> Application base DAM object\n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"onlyAllowed","in":"query","description":"If true, returns only allowed action according to the user grants.","schema":{"type":"boolean"}},{"name":"rawValues","in":"query","description":"True to disable localization.","schema":{"type":"boolean"},"required":false}],"responses":{"200":{"description":"List of possible workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/workflow/dam.data.asset.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","readOnly":true,"description":"list of possible workflow actions","properties":{"data":{"type":"object","readOnly":true,"description":"Workflow actions.\n\nThe name of properties is the ID and the corresponding value is the name of the action","additionalProperties":{"type":"string"},"example":{"1":"publish","5":"review"}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Apply a workflow action to the given asset.","description":"Change the workflow of given asset by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.asset.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given asset.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"post":{"summary":"Apply a workflow action to the given asset.","description":"Change the workflow of given asset by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.asset.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given asset.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"put":{"summary":"Apply a workflow action to the given asset.","description":"Change the workflow of given asset by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.asset.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given asset.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/workflow/unsplashimport/{resourceId}":{"get":{"summary":"Gets given asset workflow actions.","description":"Gets the list of possible workflow actions for the specified ID asset.\n\n\n> Application base DAM object\n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"onlyAllowed","in":"query","description":"If true, returns only allowed action according to the user grants.","schema":{"type":"boolean"}},{"name":"rawValues","in":"query","description":"True to disable localization.","schema":{"type":"boolean"},"required":false}],"responses":{"200":{"description":"List of possible workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/workflow/unsplashimport/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","readOnly":true,"description":"list of possible workflow actions","properties":{"data":{"type":"object","readOnly":true,"description":"Workflow actions.\n\nThe name of properties is the ID and the corresponding value is the name of the action","additionalProperties":{"type":"string"},"example":{"1":"publish","5":"review"}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Apply a workflow action to the given asset.","description":"Change the workflow of given asset by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/unsplashimport/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given asset.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"post":{"summary":"Apply a workflow action to the given asset.","description":"Change the workflow of given asset by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/unsplashimport/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given asset.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"put":{"summary":"Apply a workflow action to the given asset.","description":"Change the workflow of given asset by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/unsplashimport/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the asset from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given asset.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/workflow/dam.data.brandcenter.update/{resourceId}":{"get":{"summary":"Gets given brand center workflow actions.","description":"Gets the list of possible workflow actions for the specified ID brand center.\n\n\n> Unique DAM funds for the WEDIA PACKAGED application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the brand center from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"onlyAllowed","in":"query","description":"If true, returns only allowed action according to the user grants.","schema":{"type":"boolean"}},{"name":"rawValues","in":"query","description":"True to disable localization.","schema":{"type":"boolean"},"required":false}],"responses":{"200":{"description":"List of possible workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/workflow/dam.data.brandcenter.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","readOnly":true,"description":"list of possible workflow actions","properties":{"data":{"type":"object","readOnly":true,"description":"Workflow actions.\n\nThe name of properties is the ID and the corresponding value is the name of the action","additionalProperties":{"type":"string"},"example":{"1":"publish","5":"review"}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of brand center is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Apply a workflow action to the given brand center.","description":"Change the workflow of given brand center by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.brandcenter.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the brand center from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given brand center.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of brand center or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"post":{"summary":"Apply a workflow action to the given brand center.","description":"Change the workflow of given brand center by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.brandcenter.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the brand center from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given brand center.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of brand center or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"put":{"summary":"Apply a workflow action to the given brand center.","description":"Change the workflow of given brand center by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.brandcenter.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the brand center from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given brand center.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of brand center or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/workflow/dam.data.legacy.update/{resourceId}":{"get":{"summary":"Gets given legacy workflow actions.","description":"Gets the list of possible workflow actions for the specified ID legacy.\n\n\n> Legacy assets in the demo application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the legacy from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"onlyAllowed","in":"query","description":"If true, returns only allowed action according to the user grants.","schema":{"type":"boolean"}},{"name":"rawValues","in":"query","description":"True to disable localization.","schema":{"type":"boolean"},"required":false}],"responses":{"200":{"description":"List of possible workflow actions","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/workflow/dam.data.legacy.update/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","readOnly":true,"description":"list of possible workflow actions","properties":{"data":{"type":"object","readOnly":true,"description":"Workflow actions.\n\nThe name of properties is the ID and the corresponding value is the name of the action","additionalProperties":{"type":"string"},"example":{"1":"publish","5":"review"}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of legacy is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Apply a workflow action to the given legacy.","description":"Change the workflow of given legacy by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.legacy.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the legacy from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given legacy.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of legacy or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"post":{"summary":"Apply a workflow action to the given legacy.","description":"Change the workflow of given legacy by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.legacy.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the legacy from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given legacy.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of legacy or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"put":{"summary":"Apply a workflow action to the given legacy.","description":"Change the workflow of given legacy by applying specified workflow action.","tags":["workflows"],"parameters":[{"name":"resourceId","in":"path","description":"Name of action.\nGet the list of action with GET /workflow/dam.data.legacy.update/{resourceId}.","schema":{"type":"integer"},"required":true},{"name":"id","in":"query","description":"ID of the legacy from which to get the workflow actions.","schema":{"type":"integer"},"required":true},{"name":"action","in":"query","description":"ID or name of workflow action to apply to given legacy.","schema":{"oneOf":[{"type":"integer"},{"type":"string"}]},"required":true}],"responses":{"200":{"description":"the workflow state has been successfully modified"},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of legacy or action to apply is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/208|Occurs when user is not allowed to apply the specified action on the specified object.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/208)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/208"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/208"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/delete/dam.data.asset/{resourceId}":{"delete":{"summary":"Delete a given asset resource.","description":"Delete asset corresponding to specified id.\n\n\n\n> Application base DAM object\n","tags":["delete"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the asset to delete.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"The specified object has been successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of action.","readOnly":true,"example":"dam.data.asset"},"actionDescription":{"type":"string","description":"Description of action.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/delete/dam.data.asset/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of asset is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/302|Occurs when you try to delete a resource and security prohibits it.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/302)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/302"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/302"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/delete/dam.data.brandcenter/{resourceId}":{"delete":{"summary":"Delete a given brand center resource.","description":"Delete brand center corresponding to specified id.\n\n\n\n> Unique DAM funds for the WEDIA PACKAGED application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["delete"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the brand center to delete.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"The specified object has been successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of action.","readOnly":true,"example":"dam.data.brandcenter"},"actionDescription":{"type":"string","description":"Description of action.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/delete/dam.data.brandcenter/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of brand center is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/302|Occurs when you try to delete a resource and security prohibits it.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/302)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/302"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/302"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/delete/data.transfer/{resourceId}":{"delete":{"summary":"Delete a given data.transfer resource.","description":"Delete data.transfer corresponding to specified id.","tags":["delete"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the data.transfer to delete.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"The specified object has been successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of action.","readOnly":true,"example":"data.transfer"},"actionDescription":{"type":"string","description":"Description of action.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/delete/data.transfer/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of data.transfer is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/302|Occurs when you try to delete a resource and security prohibits it.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/302)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/302"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/302"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/delete/dam.data.legacy/{resourceId}":{"delete":{"summary":"Delete a given legacy resource.","description":"Delete legacy corresponding to specified id.\n\n\n\n> Legacy assets in the demo application\n> \n> == Facets\n> *default* facet is always applied. Its purpose is to hide properties that are not common to every instance stored in the system. \n","tags":["delete"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the legacy to delete.","schema":{"type":"integer"},"required":true}],"responses":{"200":{"description":"The specified object has been successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{"actionName":{"type":"string","description":"ID of action.","readOnly":true,"example":"dam.data.legacy"},"actionDescription":{"type":"string","description":"Description of action.","readOnly":true},"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/delete/dam.data.legacy/123"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs when request is bad.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when identifier of legacy is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"404":{"description":"Occurs when resource is not found.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|404/900|Occurs when specified object id has not been found.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#404/900)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"404/900"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Resource not found."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#404/900"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"false"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs when action is not allowed.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/302|Occurs when you try to delete a resource and security prohibits it.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/302)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/302"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/302"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}},"/imaging/clubwedlist/{resourceId}":{"get":{"summary":"Transform resource image","description":"Get transformed image from specified resource.","tags":["imaging"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource from which to get the binary file.","schema":{"type":"integer"},"required":true},{"name":"transform","in":"query","description":"Imaging commands to transform the image.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"string"},"required":false},{"name":"commands","in":"query","description":"Imaging commands to transform the image. Ignored if transform is specified.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"object","format":"jsonquery","additionalProperties":true},"required":false},{"name":"preset","in":"query","description":"Imaging preset to transform the image. Ignored if transform or commands is specified.","schema":{"type":"string"},"required":false},{"name":"strip","in":"query","description":"If true, removes all metadata in transformed image","schema":{"type":"boolean","default":true},"required":false},{"name":"attachment","in":"query","description":"If true, returns the Content-Disposition header filled with attachment data","schema":{"type":"boolean","default":true},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response. \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"The binary file resource","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}}}},"/imaging/clubwedlista/{resourceId}":{"get":{"summary":"Transform resource image","description":"Get transformed image from specified resource.","tags":["imaging"],"parameters":[{"name":"resourceId","in":"path","description":"ID of the resource from which to get the binary file.","schema":{"type":"integer"},"required":true},{"name":"transform","in":"query","description":"Imaging commands to transform the image.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"string"},"required":false},{"name":"commands","in":"query","description":"Imaging commands to transform the image. Ignored if transform is specified.\n\n [See documentation of transform commands](https://crossmedia.atlassian.net/wiki/spaces/WD/pages/379912195/Imaging+downloading+and+applying+image+transformations)","schema":{"type":"object","format":"jsonquery","additionalProperties":true},"required":false},{"name":"preset","in":"query","description":"Imaging preset to transform the image. Ignored if transform or commands is specified.","schema":{"type":"string"},"required":false},{"name":"strip","in":"query","description":"If true, removes all metadata in transformed image","schema":{"type":"boolean","default":true},"required":false},{"name":"attachment","in":"query","description":"If true, returns the Content-Disposition header filled with attachment data","schema":{"type":"boolean","default":true},"required":false},{"name":"lang","in":"query","description":"Language (override header Accept-Language).","schema":{"type":"string"},"required":false},{"name":"state","in":"query","description":"The value of this parameter is returned as it is in the response. \n\n[See more about state parameter here]: #general-parameter-state \"More about state parameter\"\n\n[See more about state parameter here]","schema":{},"required":false}],"responses":{"200":{"description":"The binary file resource","content":{"*/*":{"schema":{"type":"string","format":"binary"}}}}}}},"/whoami":{"get":{"summary":"Gets current user data.","description":"Gets data for the current connected user.","tags":["user"],"parameters":[{"name":"rawValues","in":"query","description":"True to disable localization.","schema":{"type":"boolean"},"required":false}],"responses":{"200":{"description":"Data for the current user","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/whoami"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","properties":{"data":{"type":"object","description":"Data for current user","properties":{"id":{"type":"string","description":"user ID","example":"123"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","nullable":true,"description":"user UUID","example":"nyoxeaw5zfjd6tc6zw3qnt7s7h"},"login":{"type":"string","nullable":true,"description":"user login","example":"john.smith"},"name":{"type":"string","nullable":true,"description":"user login","example":"John Smith"},"email":{"type":"string","nullable":true,"description":"user login","example":"john.smith@crowd.org"},"roleid":{"type":"string","description":"role id","example":"1"},"role":{"type":"string","description":"role name","example":"Public"},"locale":{"type":"string","description":"user locale (ISO639)","example":"en_US"},"queryLocale":{"type":"string","description":"current user locale (ISO639). Usually the user locale, but could be overrided by parameter **lang**","example":"en_US"},"userdata":{"type":"object","description":"user data","properties":{"contriblangs":{"type":"array","description":"Data for language.","items":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"}}}}}},"loginHints":{"type":"object","description":"in case of oauth2 authentification, the login hints","properties":{"id":{"type":"string","description":"id"},"login_hint":{"type":"string","description":"login"}}},"isUser":{"type":"boolean","description":"True only if current connection is a user connection, or if it is an application connection bound to a user (see isApp)"},"isApp":{"type":"boolean","description":"True only if current connection is an application that is not bound to a user (see isUser)"},"application":{"type":"object","nullable":true,"description":"If current connection is an application, describes this application. Otherwise, the value is null","properties":{"name":{"type":"string","description":"Name of application"},"user":{"type":"string","description":"name of virtual user provided when signin to the application (or anonymous, if no one)"},"isUser":{"type":"boolean","description":"True if application is bound to a user"}}},"properties":{"type":"object","nullable":true,"description":"list of custom properties","additionalProperties":true}}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}}}}},"/userpref":{"get":{"summary":"Get user preferences","description":"Get user preferences","tags":["user"],"parameters":[{"name":"namespace","in":"query","description":"Preference store namespace.","schema":{"type":"string"},"required":true},{"name":"key","in":"query","description":"Preference key in a preference store namespace.","schema":{"type":"string"},"required":true},{"name":"name","in":"query","description":"Preference name in a preference key.","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"Requested preference values","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/userpref"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","properties":{"data":{"type":"object","description":"Data for preferences","properties":{"type":{"type":"string","enum":["boolean","number","string","array","object","null"],"description":"The type of the preference value, or null if it cannot be determined."},"value":{"oneOf":[{"type":"boolean","description":"Boolean value if the preference is a boolean.","nullable":true},{"type":"number","description":"Number value if the preference is a number.","nullable":true},{"type":"string","description":"String value if the preference is a string.","nullable":true},{"type":"array","description":"Array of values if the preference is an array.","items":{},"nullable":true},{"type":"object","description":"JSon Object if the preference is an object","nullable":true}]}}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when a mandatory parameter is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs if action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/1001|Occurs when if action is forbidden.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/1001)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/1001"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/1001"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"post":{"summary":"Set user preferences","description":"Add a preference value to a key in a namespace","tags":["user"],"parameters":[{"name":"namespace","in":"query","description":"Preference store namespace.","schema":{"type":"string"},"required":true},{"name":"key","in":"query","description":"Preference key in a preference store namespace.","schema":{"type":"string"},"required":true},{"name":"name","in":"query","description":"Preference name in a preference key.","schema":{"type":"string"},"required":false},{"name":"value","in":"query","description":"Preference value. You can pass `#null` to set null value.","schema":{},"required":true},{"name":"type","in":"query","description":"Indicative type for a preference value.","schema":{"type":"string","enum":["boolean","string","number","array","object"]},"required":false}],"responses":{"200":{"description":"The new value of preference","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/userpref"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","properties":{"data":{"type":"object","description":"Data for preferences","properties":{"type":{"type":"string","enum":["boolean","number","string","array","object","null"],"description":"The type of the preference value, or null if it cannot be determined."},"value":{"oneOf":[{"type":"boolean","description":"Boolean value if the preference is a boolean.","nullable":true},{"type":"number","description":"Number value if the preference is a number.","nullable":true},{"type":"string","description":"String value if the preference is a string.","nullable":true},{"type":"array","description":"Array of values if the preference is an array.","items":{},"nullable":true},{"type":"object","description":"JSon Object if the preference is an object","nullable":true}]}}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when a mandatory parameter is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/3|Occurs when the preference value is not accepted.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs if action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/1001|Occurs when if action is forbidden.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/1001)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/1001"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/1001"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"put":{"summary":"Set user preferences","description":"Set a preference value to a key in a namespace","tags":["user"],"parameters":[{"name":"namespace","in":"query","description":"Preference store namespace.","schema":{"type":"string"},"required":true},{"name":"key","in":"query","description":"Preference key in a preference store namespace.","schema":{"type":"string"},"required":true},{"name":"name","in":"query","description":"Preference name in a preference key.","schema":{"type":"string"},"required":false},{"name":"value","in":"query","description":"Preference value. You can pass `#null` to set null value.","schema":{},"required":true},{"name":"type","in":"query","description":"Indicative type for a preference value.","schema":{"type":"string","enum":["boolean","string","number","array","object"]},"required":false}],"responses":{"200":{"description":"The new value of preference","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/userpref"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","properties":{"data":{"type":"object","description":"Data for preferences","properties":{"type":{"type":"string","enum":["boolean","number","string","array","object","null"],"description":"The type of the preference value, or null if it cannot be determined."},"value":{"oneOf":[{"type":"boolean","description":"Boolean value if the preference is a boolean.","nullable":true},{"type":"number","description":"Number value if the preference is a number.","nullable":true},{"type":"string","description":"String value if the preference is a string.","nullable":true},{"type":"array","description":"Array of values if the preference is an array.","items":{},"nullable":true},{"type":"object","description":"JSon Object if the preference is an object","nullable":true}]}}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when a mandatory parameter is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/3|Occurs when the preference value is not accepted.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs if action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/1001|Occurs when if action is forbidden.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/1001)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/1001"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/1001"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"patch":{"summary":"Set user preferences","description":"Set a preference value to a key in a namespace","tags":["user"],"parameters":[{"name":"namespace","in":"query","description":"Preference store namespace.","schema":{"type":"string"},"required":true},{"name":"key","in":"query","description":"Preference key in a preference store namespace.","schema":{"type":"string"},"required":true},{"name":"name","in":"query","description":"Preference name in a preference key.","schema":{"type":"string"},"required":false},{"name":"value","in":"query","description":"Preference value. You can pass `#null` to set null value.","schema":{},"required":true},{"name":"type","in":"query","description":"Indicative type for a preference value.","schema":{"type":"string","enum":["boolean","string","number","array","object"]},"required":false}],"responses":{"200":{"description":"The new value of preference","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/userpref"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"response":{"type":"object","properties":{"data":{"type":"object","description":"Data for preferences","properties":{"type":{"type":"string","enum":["boolean","number","string","array","object","null"],"description":"The type of the preference value, or null if it cannot be determined."},"value":{"oneOf":[{"type":"boolean","description":"Boolean value if the preference is a boolean.","nullable":true},{"type":"number","description":"Number value if the preference is a number.","nullable":true},{"type":"string","description":"String value if the preference is a string.","nullable":true},{"type":"array","description":"Array of values if the preference is an array.","items":{},"nullable":true},{"type":"object","description":"JSon Object if the preference is an object","nullable":true}]}}}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when a mandatory parameter is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/3|Occurs when the preference value is not accepted.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs if action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/1001|Occurs when if action is forbidden.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/1001)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/1001"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/1001"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}},"delete":{"summary":"Delete user preferences","description":"Delete a preference key in a namespace","tags":["user"],"parameters":[{"name":"namespace","in":"query","description":"Preference store namespace.","schema":{"type":"string"},"required":true},{"name":"key","in":"query","description":"Preference key in a preference store namespace.","schema":{"type":"string"},"required":true},{"name":"name","in":"query","description":"Preference name in a preference key.","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"The new value of preference","content":{"application/json":{"schema":{"type":"object","properties":{"request":{"type":"object","description":"Description of the request (only in debug mode / not available in production mode).","properties":{"version":{"type":"string","description":"Version of WEDIA API","readOnly":true,"example":"2.0"},"parameters":{"type":"object","description":"Request parameters","additionalProperties":true,"readOnly":true},"URI":{"type":"string","format":"uri","description":"Relative URI of request","readOnly":true,"example":"https://club-wed.wedia-group.com:443/userpref"},"context":{"type":"object","description":"Request context (part of configuration built from request parameters)","readOnly":true,"additionalProperties":true}}},"state":{"description":"the value of state parameter","oneOf":[{"type":"string"},{"type":"object","description":"if the state is a json object, it is directly exported as json value within response json tree, instead of json serialized as a character string (as any other state value)"}]},"version":{"type":"string","description":"version of the endpoint","readOnly":true,"example":"2.4"},"status":{"type":"integer","format":"int32","description":"status of the response","readOnly":true,"example":200},"time":{"type":"integer","format":"int64","description":"execution time in ms","readOnly":true,"example":352}}}}}},"400":{"description":"Occurs in case of wrong parameter.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|400/0|Occurs when a mandatory parameter is missing.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/0)|\n|400/3|Occurs when the preference value is not accepted.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#400/3)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"400/0"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Bad request. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#400/0"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}},"403":{"description":"Occurs if action is forbidden.\n______\nSpecific error codes:\n\n| Error code | Circumstances | Error Documentation |\n|:-----------|:--------------|:--------------------|\n|403/1001|Occurs when invoking user preferences action is prohibited.|[See documentation](https://club-wed.wedia-group.com:443/api/rest/errors#403/1001)|\n\n","content":{"application/json":{"schema":{"type":"object","description":"Description of error.","properties":{"error":{"type":"string","description":"Uniq error code.\nIt is composed of two parts separated by a slash:\n- a standard HTTP code;\n- a specific code.","example":"403/1001"},"message":{"type":"string","description":"A human readable message (to display error description to user).","example":"Action forbidden. Please, contact your administrator."},"submessage":{"type":"string","description":"A more specific human readable message (where relevant)."},"error_uri":{"type":"string","description":"Error documentation URI.","example":"https://club-wed.wedia-group.com:443/api/rest/errors#403/1001"},"errorWithContact":{"type":"boolean","description":" if true, the message invites user to contact a support or administration department.","example":"true"},"errorSupportDetails":{"type":"object","description":"Information to handle error message reporting by email.","properties":{"value":{"type":"string","description":"Label for a button to send error informations to support by email.","example":"Wedia support email: support@wedia-group.com."},"key":{"type":"string","description":"A key to generate custom button label.","example":"WEDIA_ERROR_SUPPORT"},"params":{"type":"array","description":"Parameters to generate custom button label.","items":{"type":"string"},"example":"[support@wedia-group.com]"}}},"errtag":{"type":"string","description":"A code to retrieve corresponding entry in logs.","example":"7a6"}}}}}}}}}},"components":{"schemas":{"view-assets":{"type":"object","title":"asset","description":"Data structure of resource asset. \n\n\n\n> Application base DAM object\n","properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"name":{"type":"string","description":"Value of name"},"color":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"}},"description":"Data for color."}},"description":"Data for status."},"name":{"type":"string","description":"Value of name"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","format":"path","description":"File path or file name","example":"file.jpg"},"localURL":{"type":"string","format":"uri","description":"URL of the file from server itself","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/transform/75u6r8xas31bw/out"},"remoteURL":{"type":"string","format":"uri","description":"URL of the file","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/transform/75u6r8xas31bw/out"},"thumbnailSmall":{"type":"string","format":"uri","description":"Relative URL to get a small thumbnail variation of the file","example":"/api/wedia/dam/variation/75u6r8xas31bw/thumbnailSmall"},"thumbnailSmallLocalURL":{"type":"string","format":"uri","description":"URL of the thumbnail from server itself","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/variation/75u6r8xas31bw/thumbnailSmall"},"thumbnailSmallRemoteURL":{"type":"string","format":"uri","description":"URL of the thumbnail","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/variation/75u6r8xas31bw/thumbnailSmall"}}}}},"create_report-dam.data.asset.add":{"type":"object","description":"Data of created asset","readOnly":true,"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"name":{"type":"string","description":"Value of name"}}},"update_report-dam.data.asset.update":{"type":"object","description":"Data of modified asset","readOnly":true,"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"}}},"create_report-dam.data.brandcenter.add":{"type":"object","description":"Data of created brand center","readOnly":true,"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"name":{"type":"string","description":"Value of name"}}},"update_report-dam.data.brandcenter.update":{"type":"object","description":"Data of modified brand center","readOnly":true,"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"}}},"create_report-dam.data.legacy.add":{"type":"object","description":"Data of created legacy","readOnly":true,"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"name":{"type":"string","description":"Value of name"}}},"update_report-dam.data.legacy.update":{"type":"object","description":"Data of modified legacy","readOnly":true,"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"}}},"view-transfer":{"type":"object","title":"transfer","description":"Data structure of resource transfer.","properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"status":{"properties":{"id":{"type":"integer","format":"int64","description":"Value of id"},"$uuid":{"type":"string","pattern":"^[0-9A-Fa-f]{2,}$","description":"Value of UUID"},"name":{"type":"string","description":"Value of name"}},"description":"Data for workflow."},"name":{"type":"string","description":"Value of name"},"binary":{"type":"object","description":"Data for file property (binary content)","properties":{"serverPath":{"type":"string","format":"path","description":"File path or file name","example":"file.jpg"},"localURL":{"type":"string","format":"uri","description":"URL of the file from server itself","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/transform/e59jun78s19zp75kunii5mao1e/out"},"remoteURL":{"type":"string","format":"uri","description":"URL of the file","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/transform/e59jun78s19zp75kunii5mao1e/out"},"thumbnailSmall":{"type":"string","format":"uri","description":"Relative URL to get a small thumbnail variation of the file","example":"/api/wedia/dam/variation/e59jun78s19zp75kunii5mao1e/thumbnailSmall"},"thumbnailSmallLocalURL":{"type":"string","format":"uri","description":"URL of the thumbnail from server itself","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/variation/e59jun78s19zp75kunii5mao1e/thumbnailSmall"},"thumbnailSmallRemoteURL":{"type":"string","format":"uri","description":"URL of the thumbnail","example":"https://club-wed.wedia-group.com:443/api/wedia/dam/variation/e59jun78s19zp75kunii5mao1e/thumbnailSmall"}}}}}}},"externalDocs":{"url":"https://crossmedia.atlassian.net/wiki/spaces/WD/pages/16547995/Integration+with+the+Wedia+Rest+API","description":"Find out more about Wedia REST API"}}